Dojo

Overview

Dojo is HackYourFuture's in-house management tool designed to track HackYourFuture trainee progress, performance, attendance, assignments, graduation status, and other relevant data, facilitating efficient management of trainees information.

Screenshots

Table of contents

• Features
• Technology Stack
• Getting Started
• Usage
• Contributing
• License
• Contact

Features

• Search for trainees, volunteers and organisations
• View and update trainee profile
• Track trainee progress and performance
• Generate real-time reports
• Trainees overview, grouped by cohort
• Partner organisations overview, with a profile to view and update each one
• Volunteers overview, with a profile to view and update each one
• Secure authentication using Google OAuth

Technology Stack

A React single-page app on top of a Spring Boot REST API and a PostgreSQL database. Sign-in is Google OAuth, profile pictures are kept in S3-compatible storage, and trainee and volunteer changes are posted to Slack.

Front-end

Back-end

Deployment

The server folder holds the legacy Node.js, Express and MongoDB back-end, which server-spring replaces.

Getting Started

Prerequisites

Ensure you have the following installed:

• Node.js version 24 or above, with npm
• For the full setup: Java 25 and Docker

Option 1: Quick setup for front-end development only

If you only work on the front-end, you can connect to a remote deployed backend instead of running a server locally. This saves some time and configuration.

1. Navigate to the front-end directory:

   cd client

2. Install the dependencies:

   npm run setup

3. Copy .env.example to .env

4. Replace VITE_BACKEND_PROXY_TARGET and VITE_GOOGLE_CLIENTID with the correct values of the test server

5. Start the app:

   npm run dev

6. The app should be accessible at http://localhost:8888/

Option 2: Full setup (front-end & back-end)

1. Set up the server from the detailed instructions in server-spring/README.md. Make sure the back-end is running before setting up the front-end.

2. Set up the client from the detailed instructions in client/README.md

3. The back-end should be accessible at http://localhost:7777/ and the front-end should be accessible at http://localhost:8888/

Usage

1. Navigate to http://localhost:8888 in the browser.
2. Log in with an authorized google account.
3. Search for a trainee to track trainee progress, contact information, employment status etc...
4. Use the Trainees page to see the full list of trainees.

Login issues

Make sure:

1. VITE_GOOGLE_CLIENTID in client/.env and the server's GOOGLE_OAUTH_CLIENTID and GOOGLE_OAUTH_CLIENTSECRET belong to the same Google OAuth client.
2. The Google account you try to authenticate has an active user in the Dojo database.
3. The Google account is on the list of the test users for the OAuth authentication in Google console.

Refer to the server and client documentation for more details.

Contributing

Contributions are welcome by opening a pull request:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature-name).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/your-feature-name).
5. Open a Pull Request.
6. Make sure the deployment build is successful.

License

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

Contact

For any inquiries or feedback, please contact the dojo team on Slack or open an issue.