Code Monkey home page Code Monkey logo

coding-challenge's Introduction

coding-challenge

Prerequisites

  • you need docker installed and node.js 18xx.
  • in case you going to run docker-compose up --build to build the project.

Installation

Explain how to set up the local development environment.

Backend

  1. Navigate to the backend directory.
  2. Run npm install to install dependencies.
  3. Set environment variables in a .env file based on the provided example. 4, for jwt secret key I used openssl rand -base64 32 to generate the key.

Frontend

  1. Navigate to the frontend directory.
  2. Run npm install to install dependencies.

With Docker

  1. Ensure Docker is installed and running.
  2. From the project root, run docker-compose up --build.

Without Docker Backend

  • Run npm start inside the backend directory.

Frontend

  • Run npm start inside the frontend directory.

API Endpoints

List the main API endpoints if your backend exposes an API.

Environment Variables

Detail the environment variables needed for the project.

  • NODE_ENV: Environment mode (e.g., development, production).
  • PORT: Server port (default: 5003).
  • JWT_SECRET: Secret key for JWT.
  • MONGO_DB: MongoDB URI.
  • REACT_APP_API_URL: URL for the React app to connect to the API.

coding-challenge's People

Contributors

samofoke avatar

Watchers

 avatar

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.