chetak123 / rap-god-api

API for the how-to-dok project.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rap-god-API


Rap-god-Image

API for the how-to-dok project.

This project will be the API for the Rap-god project that'd be used for accessing the database and implement other API-endpoints. This is where we connect the cassandra database, configure it and implement the project's idea.

The project will be shared by various working groups (including but not limited to):

  • Endpoints
  • Testing

We are using:

  • Express
  • Cassandra
  • Babel for tranpilation

Project setup

Run the following commands to setup the server

  • Add node_modules yarn dev
  • Transpile the code yarn transpile
  • Run the server yarn dev

Babel configuration

The express backend server uses the older standard of the Javascript (Accordding to the EcmaScript Standards)

We need to transpile the code from ES6+ to do the work for us, for this we need to run

yarn transpile

Docker configuration

To run the database image, run the following command: docker compose up

Run the following commands to setup the server

  • Add node_modules yarn dev
  • Transpile the code yarn transpile
  • Run the server yarn dev

About

API for the how-to-dok project.

License:MIT License


Languages

Language:JavaScript 100.0%