guillainbisimwa/elimu-backend

Elimu Backend

Built With

• Node.js
• Express
• WebSocket/ws
• MongoDb

Tested With

• Jasmine

Live Demo

Live Demo Link comming soon

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• NPM
• JavaScript

Setup

Navigate to your desired location to download the contents of this repository. In order to clone this repository just type the following commands over the terminal in Linux or Mac or the Windows cmd console.

git clone https://github.com/elimu-backend.git

Install

Run the following commands to install dependencies:

cd elimu-backend
npm install

API key Integration

Create a .env file in the root directory of this project. Add environment-specific variables on new lines in the form of NAME=VALUE. For example:

SERVER_URL=...

The environment variables from a .env file are loaded into process.env.

Usage

In order to run this project locally, just type this command:

npm start

Test

In order to test this project locally, just type this command:

1. npm test – run all tests once (this will be used to evaluate your solutions)
2. npm run test:watch - run all tests in watch mode (optionally, you can use it locally if you prefer)

Author

👤 Guillain Bisimwa

• Github : @guillainbisimwa
• Twitter : @gullain_bisimwa
• Linkedin : guillain-bisimwa

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Acknowledgments

• Pacifique AKILIMALI

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is ISC licensed.