RepoNex is a centralized dashboard platform that serves as a comprehensive hub where users can track their ongoing PRs, manage issues, and monitor repositories of interest. It integrates a team-based system, enabling seamless collaboration and coordination among team members involved in various open-source projects.
The project utilizes Docker to orchestrate both microservices within a single instance. However, if you prefer to run it without Docker, examine the scripts available under each service and proceed accordingly. Otherwise, follow these steps:
Ensure that you have Docker installed on your system before proceeding.
Before starting the Docker containers, create a .env
file inside the server
and client
directories and set the following required environment variables:
- For client:
VITE_SERVER=http://localhost:3000 VITE_GITHUB_TOKEN=your_github_classic_token
Replace your_github_classic_token
with your actual GitHub classic token for authentication in the client.
- For server:
SERVER_PORT=3000 CLIENT_PORT=5173 JWT_SECRET=your_jwt_secret POSTGRES_USER=your_username POSTGRES_PASSWORD=your_password POSTGRES_DB=reponex POSTGRES_HOST=localhost POSTGRES_PORT=5432
Replace your_jwt_secret
with a secure secret for JWT authentication/authorization and your_username
and your_password
with the desired credentials for accessing the PostgreSQL database.
-
Clone the Repository:
git clone https://github.com/BugReportOnWeb/reponex.git cd reponex
-
Start the Docker Containers:
npm run docker:up
-
Accessing the Application: Once the containers are up and running, you can access the client application via
localhost:8000
and the server vialocalhost:3000
in your web browser.
-
To stop the running containers:
npm run docker:stop
-
To start stopped containers:
npm run docker:start
-
To completely shut down and remove containers:
npm run docker:down
-
To start Docker containers with rebuilding:
npm run docker:up:build
-
To build Docker images:
npm run docker:build
BugReportOnWeb |
falcon71181 |
This project is licensed under the GNU General Public License version 3.0.