You can find the full documentation for the User Office project here.
If you're planning to contribute to this project by adding new functionality, we encourage you to discuss it first in the Discussions tab. This helps ensure that your proposed changes align with the project's goals and prevents duplicate efforts. Here's how you can initiate a discussion:
- Go to the Discussions tab.
- Start a new discussion thread outlining your proposed changes.
- Wait for feedback and consensus before proceeding with creating a pull request.
Thank you for your interest in contributing to our project!
To be able to start both backend and frontend locally you will need to:
- Install all needed dependencies with
npm install - Start the application using
npm run devornpm run start
If .env file is not preset during startup of the project, it will be created using example.development.env file template. The example.development.env and .env files are located in apps/backend and apps/frontend accordingly.
If you want to get something running for testing purposes only, you can run the docker-compose file located at the root of the repository. Use the following steps:
- docker compose up
- Visit localhost:33000
- Use the default users for login, [email protected] (User Officer) or [email protected] (User) with password "Test1234!"
In the project directory, you can run:
Runs the app in the development mode.
- Open http://localhost:4000 to view the GraphQL playground and schema in the browser.
- Open http://localhost:3000 to view the app in the browser.
Lints typescript code and log if there are any errors.
npm run lint:fix should be used if you want to fix all auto-fixable errors and warnings.
Please refer to the Contribution guide to get information about contributing and versioning.
Happy coding! 👨💻