Skip to content

REST API backend for CharCookery, an Android project built as a course requirement for MOBDEVE.

Notifications You must be signed in to change notification settings

nicapos/charcookery-nodejs

Repository files navigation

CharCookery

A REST API backend for CharCookery, an Android project built as a course requirement for MOBDEVE.

Installation

  1. Clone the repository:
git clone https://github.com/nicapos/charcookery-nodejs.git
cd charcookery-nodejs
  1. Initialize and install the necessary modules.
npm install
  1. Configure environment variables. Duplicate the .env.example file and name it as .env. Fill in the required environment variables in the file with the appropriate values.

Usage

To start the application in development, run:

npm run start

This will start the server at localhost:3000 and the documentation at localhost:3000/docs (or replace with the port specified in your .env file if different).

To build the app at /dist, run:

npm run build

After building, you can start the app in production by running:

npm run serve

About

REST API backend for CharCookery, an Android project built as a course requirement for MOBDEVE.

Topics

Resources

Stars

Watchers

Forks