Project Overview:
CodeChum Backend is a personal project designed to complement the original CodeChum by providing a robust backend service. Built as a fun challenge, this project aims to replicate the backend functionality of CodeChum, facilitating coding challenges and enhancing my programming skills. This backend works in conjunction with the CodeShum frontend.
Features:
- API for Challenges: Access a variety of coding challenges through a RESTful API, categorized by difficulty and topic.
- Real-time Terminal: Use WebSocket to create a live terminal experience, allowing users to run code and receive instant feedback.
- User Management: Implement user authentication and profile management to track progress and achievements.
- Data Persistence: Store user data and challenge information in MongoDB for reliable data management.
Technologies Used:
- Backend: Express.js
- Database: MongoDB
- Real-time Communication: WebSocket
Getting Started:
To get started with CodeChum Backend locally, follow these steps:
- Clone the repository:
git clone https://github.com/kintoyyy/codechum-backend.git - Install dependencies:
npm install(oryarn install) - Configure environment variables in a
.envfile. (Refer to the.env.examplefile for structure) - Start the development server:
npm start.
Contributing:
While CodeChum Backend is a replica of the original CodeChum's backend, any contributions or suggestions for improvements are welcome! Please submit a pull request or open an issue to discuss potential updates.
License:
This project is licensed under the MIT License - see the LICENSE file for details.
Contact:
For questions, feedback, or support, contact Kent Rato via email at kent.oyyyyyyyy@gmail.com.
Happy coding!