Level Up - Security Server

Server made with Javascript technologies Main access for LevelUp Applications

To get Started

1. Please ask someone the .env.
2. Download the project.
3. CD into the root project and run: npm install
4. Run npm run dev.

Installation

This project requires Node.js v14+ to run.

Using .nvmrc file helps to normalize node version used by all maintainers. If you are required to use version specified in this file, run these commands.

nvm use
nvm install

Use the package manager npm v6+ to install dependencies and devDependencies.

npm install

Usage

Rename environment file shared to .env

mv ENV_FILE .env

Port

Change defualt port (3000) to other port if needed. Open .env file and add

PORT=3001

If you are using a local MongoDB database, start the mongod service

sudo service mongod start

Run server

npm run dev

Redis on Dev mode.

• This application uses Redis , so in order to get started locally follow these steps:
  1. On the root project please run docker-compose up
  2. On any terminal for Redis cli you can use redis-insight (Download here)[https://redislabs.com/redis-enterprise/redis-insight/]
  3. Or if you want you can run the redis-cli via docker running on any terminal : docker run -it --network securitylul_default --rm redis redis-cli -h redislul

If you are having troubles with redis, check this guide

Updating schema models

git submodule init
npm run updateModels

Utilities

Format code using Prettier and Eslint

npm run prettify

Tech Stack

• NodeJs
• ExpressJs
• MongoDB
• Redis

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Notes on developing:

- Linters and Format are added to this project so please everytime you submit a PR, run the command: `npm run prettify`, and fix any errors that pops up.

Commits Commits must follow conventional commit format Make sure your messages look like the following examples

feat: Adding new endpoint
fix: Rolling back endpoint

License

ISC