AltCampv1-backend

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

• Base URL (dev): https://altcamp.onrender.com
• Base URL (prod): https://api.thealtcamp.com
• Documentation: https://altcamp.onrender.com/api-docs or <base_url>/api-docs
• Postman Collection: https://documenter.getpostman.com/view/21313847/2s93eePUTg#intro

Frontend

• Live URL: https://altcampv1.netlify.app
• GitHub Repository: https://github.com/AltCamp/altcampv1-frontend

Design

• Figma: https://www.figma.com/file/xYVO33gFoAqIJMyluGdd8M/ALTCAMP?type=design&node-id=112-1241&mode=design&t=wzi8NTlLzrpQP9dU-0

Project Management

• Project Board: https://coda.io/d/AltCamp_dD2LqZxW5Lw/Back-End-Engineering-Team_su_Ao#_luCDb

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

2. Navigate into the cloned repository folder:

   $ cd altcampv1-backend

3. Install dependencies:

   $ npm install

4. Copy the example environment file and make the required configuration changes in the .env file:

   $ cp example.env .env

5. Start the application:

   $ npm run start:dev

6. Run tests:

   $ npm run test

7. 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:

• Contributing Guidelines
• Style Guide
• Code of Conduct

License

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

Contributors

Precious Abubakar 💻 ⚠️ 🚧 👀	Tobi Balogun 🚧 💻 ⚠️ 👀	Awosise Oluwaseun 💻 ⚠️ 👀	Samuel Adeboye Folaranmi 📖 💻 👀	skyreal 💻	Munir Abdullahi 🤔 👀 📖	Anthonia Nwanya 💻
Nonso Andrew Ugbodu 💻 ⚠️	Module 💻

Acknowledgements

• AltSchool Africa