altcampv1-backend

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

altcampv1-backend

(★ 14)

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.

altcampv1-backend Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# AltCampv1-backend

[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](https://raw.githubusercontent.com/AltCamp/altcampv1-backend/dev/)

## 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](https://nodejs.org/en/) - JavaScript runtime environment
- [Express](https://expressjs.com/) - Web framework for Node.js
- [MongoDB](https://www.mongodb.com/) - NoSQL database
- [Mongoose](https://mongoosejs.com/) - MongoDB object modeling for Node.js
- [Jest](https://jestjs.io/) - JavaScript testing framework
- [Supertest](https://github.com/ladjs/supertest#readme) - HTTP assertions made easy via superagent

## Quick Start

1. Clone the repository:

```bash
  $ git clone https://github.com/AltCamp/altcampv1-backend.git
  ```

2. Navigate into the cloned repository folder:

```bash
  $ cd altcampv1-backend
  ```

3. Install dependencies:

```bash
  $ npm install
  ```

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

```bash
  $ cp example.env .env
  ```

5. Start the application:

```bash
  $ npm run start:dev
  ```

6. Run tests:

```bash
  $ npm run test
  ```

7. Import the [Postman collection](https://documenter.getpostman.com/view/21313847/2s93eePUTg#intro) 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](/CONTRIBUTING.md)
- [Style Guide](/CONTRIBUTING.md#style-guide)
- [Code of Conduct](/CODE_OF_CONDUCT.md)

## License

This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.

## Contributors

<table>
 <tbody>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="http://github.com/misspee007"><img src="https://avatars.githubusercontent.com/u/71160347?v=4?s=100" width="100px;" alt="Precious Abubakar"/> Precious Abubakar</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=misspee007" title="Code">💻</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=misspee007" title="Tests">⚠️</a> <a href="#maintenance-misspee007" title="Maintenance">🚧</a> <a href="https://github.com/AltCamp/altcampv1-backend/pulls?q=is%3Apr+reviewed-by%3Amisspee007" title="Reviewed Pull Requests">👀</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/tobisupreme"><img src="https://avatars.githubusercontent.com/u/98078707?v=4?s=100" width="100px;" alt="Tobi Balogun"/> Tobi Balogun</a> <a href="#maintenance-tobisupreme" title="Maintenance">🚧</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=tobisupreme" title="Code">💻</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=tobisupreme" title="Tests">⚠️</a> <a href="https://github.com/AltCamp/altcampv1-backend/pulls?q=is%3Apr+reviewed-by%3Atobisupreme" title="Reviewed Pull Requests">👀</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/jhhornn"><img src="https://avatars.githubusercontent.com/u/66667958?v=4?s=100" width="100px;" alt="Awosise Oluwaseun"/> Awosise Oluwaseun</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=jhhornn" title="Code">💻</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=jhhornn" title="Tests">⚠️</a> <a href="https://github.com/AltCamp/altcampv1-backend/pulls?q=is%3Apr+reviewed-by%3Ajhhornn" title="Reviewed Pull Requests">👀</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://boyei.tech/"><img src="https://avatars.githubusercontent.com/u/74235313?v=4?s=100" width="100px;" alt="Samuel Adeboye Folaranmi"/> Samuel Adeboye Folaranmi</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=Boye95" title="Documentation">📖</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=Boye95" title="Code">💻</a> <a href="https://github.com/AltCamp/altcampv1-backend/pulls?q=is%3Apr+reviewed-by%3ABoye95" title="Reviewed Pull Requests">👀</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://emerge-testing.vercel.app/signup"><img src="https://avatars.githubusercontent.com/u/102043619?v=4?s=100" width="100px;" alt="skyreal"/> skyreal</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=Skywonda" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/iamaamunir"><img src="https://avatars.githubusercontent.com/u/94959280?v=4?s=100" width="100px;" alt="Munir Abdullahi"/> Munir Abdullahi</a> <a href="#ideas-iamaamunir" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/AltCamp/altcampv1-backend/pulls?q=is%3Apr+reviewed-by%3Aiamaamunir" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=iamaamunir" title="Documentation">📖</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/AnthoniaNwanya"><img src="https://avatars.githubusercontent.com/u/105661899?v=4?s=100" width="100px;" alt="Anthonia Nwanya"/> Anthonia Nwanya</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=AnthoniaNwanya" title="Code">💻</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/Arndy345"><img src="https://avatars.githubusercontent.com/u/56146728?v=4?s=100" width="100px;" alt="Nonso Andrew Ugbodu"/> Nonso Andrew Ugbodu</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=Arndy345" title="Code">💻</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=Arndy345" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://linktr.ee/olatisun"><img src="https://avatars.githubusercontent.com/u/86102079?v=4?s=100" width="100px;" alt="Module"/> Module</a> <a href="https://github.com/AltCamp/altcampv1-backend/commits?author=Olatisunkanmi" title="Code">💻</a></td>
 </tr>
 </tbody>
</table>

## Acknowledgements

- [AltSchool Africa](https://www.altschoolafrica.com/schools/engineering)

altcampv1-backend

altcampv1-backend Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

altcampv1-backend

altcampv1-backend Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README