/altcampv1-backend

AltCamp is an e-learning platform that allows students to post messages to the discussion threads, interact and receive feedback from other students and instructors, and hence create a deeper understanding of the subject matter being discussed.

Primary LanguageJavaScriptMIT LicenseMIT

AltCampv1-backend

All Contributors

About AltCamp

AltCamp by AltSchool is an e-learning platform that allows students to post messages to the discussion threads, interact, and receive feedback from other students and instructors, creating a deeper understanding of the subject matter being discussed.

Quick Links

API

Frontend

Design

Project Management

Features

  • User authentication and authorization
  • User profile management
  • Communinity discussion threads, upvotes/downvotes, and likes
  • Feed posts, comments and likes

Built With

  • Node.js - JavaScript runtime environment
  • Express - Web framework for Node.js
  • MongoDB - NoSQL database
  • Mongoose - MongoDB object modeling for Node.js
  • Jest - JavaScript testing framework
  • Supertest - HTTP assertions made easy via superagent

Quick Start

  1. Clone the repository:
$ git clone https://github.com/AltCamp/altcampv1-backend.git
  1. Navigate into the cloned repository folder:
$ cd altcampv1-backend
  1. Install dependencies:
$ npm install
  1. Copy the example environment file and make the required configuration changes in the .env file:
$ cp example.env .env
  1. Start the application:
$ npm run start:dev
  1. Run tests:
$ npm run test
  1. Import the Postman collection to view the API endpoints and test the endpoints.

Contributing

We welcome contributions to this project. For detailed information on how to contribute, please read our:

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors

Precious Abubakar
Precious Abubakar

💻 ⚠️ 🚧 👀
Tobi Balogun
Tobi Balogun

🚧 💻 ⚠️ 👀
Awosise Oluwaseun
Awosise Oluwaseun

💻 ⚠️ 👀
Samuel Adeboye Folaranmi
Samuel Adeboye Folaranmi

📖 💻 👀
skyreal
skyreal

💻
Munir Abdullahi
Munir Abdullahi

🤔 👀 📖
Anthonia Nwanya
Anthonia Nwanya

💻
Nonso Andrew Ugbodu
Nonso Andrew Ugbodu

💻 ⚠️
Module
Module

💻

Acknowledgements