Code Monkey home page Code Monkey logo

unboundmnl-area-2-server's Introduction

UnboundMNL - Problem Area #2 (Server)

This is the server side of the UnboundMNL Problem Area #2. The project presents a simple REST API, exposing endpoints for the client to use. This is built using NodeJS and ExpressJS.

Recommended: Install Yarn Berry

  1. Install Node.js 14+
  2. Open a terminal on your user directory.
  3. Run corepack enable
  4. Run yarn set version stable

Environment Variables

Duplicate .env.example and rename it to .env.

PORT

The port to use for the application, defaults to 3000.

MONGODB_URI

The MongoDB URI to use for the application, defaults to mongodb://localhost:27017/unboundmnl-problem-area-2.

JWT_SECRET

The secret to use for JWT. This is required for the application to run. If not set, the application will throw an error.

FRONTEND_URLS

The comma-separated list of URLs of the frontend application. This is used for CORS. If no value is set, the application will allow all origins.

Private Files

Put any private files in the private directory. This route is protected by .gitignore and will not be committed to the repository. Put here the template application form and other private files.

Optional Development Stuff

Prettier for Code Formatting

You can install the Prettier - Code formatter extension (for VSCode). Other editors have their own extensions as well. Rules are already set in .prettierrc.json.

ESLint for Code Linting

You can install the ESLint extension (for VSCode). Other editors have their own extensions as well. Rules are already set in .eslintrc.js.

Project Setup

yarn

Start the Server

yarn start

Automatically Restart the Server on Changes

yarn watch

unboundmnl-area-2-server's People

Contributors

dwigoric avatar kndonetm avatar anaj00 avatar riki-11 avatar ricardolu1s avatar

unboundmnl-area-2-server's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.