DarkSpace

DarkSpace is a fantastic web application that is an improved version of the original NYU Brightspace, with convenient integration of GitHub Repositories and a user-friendly interface.

Project Description

Our Project is deployed on Digital Ocean and is accessible at DarkSpace.

Team: tung-tung-sahur

• Jiaxi Zhang
• Yilei Weng
• Yuquan Hu
• Henry Yu

Features

Our design inspiration comes from our experience with NYU Brightspace. We had interviews with our professor and combined our own experiences to create a more user-friendly and efficient system.

• User Authentication: Users can register, log in, and manage their profiles. Only users with special permissions can register as instructors.
• GitHub Integration: Users can link their GitHub accounts and repositories to the application. Interaction between teachers and students about assignments or contents can be done with selection of files from the GitHub repository.
• Chat System: Users can chat with each other in an inner chat system.
• Email Notifications: Users receive email notifications for new assignments, deadlines, and submissions.

Project Setup

Docker Images

Our system has mongodb and web application (2 systems) running in docker containers. Here is the link to our customized system images on Docker Hub.

Run Our Application

Here are the steps to run our application locally using Docker.

1. Clone the repository:

   git clone https://github.com/software-students-spring2025/5-final-tung-tung-sahur

   and navigate to the project directory.

2. Build the Docker images and start the containers:

   docker compose up --build

   Or

   docker-compose up --build

   Using whichever command is available on your system.

3. Open your web browser and navigate to 127.0.0.1:3000 or localhost:3000 to access the application.

4. If you want to enter the mongodb shell manually, you can do so by running:

   docker exec -it mongodb mongosh

5. When you are done, you can stop the containers by running:

   docker compose down

   Or

   docker-compose down

   Using whichever command is available on your system.

Environment Variables

Please see .env.example for all the environment variables you need to set up. Apart from the flask and mongodb variables, you need to set up the following variables:

• You need to apply for an OAuth application on GitHub to get the GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET.
• Email_password is used for email notifications.
• TEACHER_INVITE_CODE is used for the teacher registration. You can set it to any string you want.

Test:

For unit Pytest, the CI/CD work flow would be automatically running on GitHub with Actions For manually running the test, just use bash pytest tests/test_routes/test_chat_routes_extra.py(or other test.py file)