Skipper Gram API is written in Typescript with Node, Express and connected to a Mongo database you can check the code here.

fonseca-leonardo/skipper-gram-api

How to install

First you need to clone the repository using Git.

git clone <https://github.com/fonseca-leonardo/skipper-gram-api.git>

After cloning, now you have to install the dependencies with npm or yarn.

# with npm
npm install
# or with yarn
yarn install

Run Skipper Gram

After the installation process you need to create the .env file to set the environment variables, you can use the **.env.example** and complete the variables values.

#For development purpose leave it with development
ENVIROMENT=development
#When running in production enviroment use bellow value
#ENVIROMENT=production

#MongoDB host
DB_HOST=
#MongoDB port
DB_PORT=
#MongoDB username
DB_USERNAME=
#MongoDB passowrd
DB_PASSWORD=
#MongoDB database
DB_DATABASE=

#Secret for JWT authentication
TOKEN_SECRET=

#Your mail host server
MAIL_HOST=
#Your mail port server
MAIL_PORT=
#Your mail username
MAIL_USERNAME=
#Your mail password
MAIL_PASSWORD=

#Skipper frontend url
FRONT_URL=

# Port that will be opened, default is 3333
PORT=

Running in development environment

With the .env created you can start with npm or yarn:

# with npm
npm run dev

# or with yarn
yarn run dev

and happy hacking 😁

Running in production environment

First you need you build the project by running

# with npm
npm run build

# or with yarn
yarn run dev