/crowdfunding-api

Crowdfunding API

Primary LanguageTypeScript

Description

Crowdfunding API.

Prerequisites

You need Node.js installed on your local machine. You can also do it using nvm.

If you want to use Docker and Docker Compose, you have to install Docker Desktop first, check this link.

Installation

We are using yarn, so you will install all the libs with the following command:

$ yarn install

IMPORTANT: To configure git-hooks you must have at least git version 2.9. If not, postinstall script won't work, thus the hooks won't.

Define .env variables

You can pick .env.template as a template file to create a new .env file. Template file has just mock data and you have to change those values.

PS: If you are using Docker, be sure all the env vars with prefix MONGO_... are defined properly. If not, you just need to define MONGO_URI_CONNECTION which will point at your MongoDB instance.

🚨 MONGO_URI_CONNECTION: If you are using Docker, take care about the values you assign. They should be "mongodb://MONGO_USERNAME:MONGO_PASSWORD@MONGO_CONTAINER_NAME:MONGO_PORT/MONGO_DATABASE"

🚨 Only when using Docker: Check database/mongo-init.js file, you has to modify the values of the file:

db.createUser({
  user: 'DB_USER', // Same value as MONGO_USERNAME
  pwd: 'DB_USER_PASS', // Same value as MONGO_PASSWORD
  roles: [
    {
      role: 'readWrite',
      db: 'DB_NAME', // Same value as MONGO_DATABASE
    },
  ],
});

Running the app

  • Using Docker
# watch mode
docker-compose up
  • Without Docker (IMPORTANT: You have to have a MongoDB up and running)
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

IMPORTANT:

We have added a pre-commit and pre-push hooks, so linter and test are run before pushing the code to the remote. If for some reason you don't want these processes to be run, add the flag --no-verify, for example:

# commit
git commit --no-verify -m "commit message"
# push
git push --no-verify

Testing

🕵🏼‍♂️ In progress