Skip to content

This is user office scheduler repository including both backend and frontend.

License

Notifications You must be signed in to change notification settings

UserOfficeProject/user-office-scheduler

Repository files navigation

User Office Scheduler

Build Status DeepScan grade Known Vulnerabilities


Getting started

To be able to start both backend and frontend locally you will need to:

  1. Install all needed dependencies with npm install
  2. Start the application using npm run dev or npm run start

Check the .env file

If .env file is not preset during startup of the project, it will be created using example.env file template The example.env and .env files are located in apps/backend and apps/frontend accordingly.

Running with docker compose

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:

  1. docker compose up
  2. For core visit localhost:3000
  3. For scheduler visit localhost:33000
  4. Use the default users for login, [email protected] (User Officer) or [email protected] (User) with password "Test1234!"

Monorepo future plans

Plan on how to continue with the monorepo in the future:

  1. Start adding the shared libraries like: shared-types, validation and others that need to be shared between different apps (example here: https://github.com/martin-trajanovski/user-office-core-monorepo). It requires craco tool for building react apps that have sources outside src folder. This will cleanup the frontend app a lot because we can move all graphql files and scripts in the shared-types lib and validation will simplify things a lot if added directly as part of the monorepo libs.

Available Scripts

In the project directory, you can run:

npm run dev

Runs the app in the development mode.

npm run lint

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.

Contribution and release versioning

Please refer to the Contribution guide to get information about contributing and versioning.

Happy coding! 👨‍💻