Merlin is Sotoon's Performance Management System.

• Merlin
  • Overview
  • Table of Contents
  • Getting Started
    • Prerequisites
    • Running the project
  • Documentation
  • Contributing
  • License

To use the project you need to install these softwares: python-3.11, node-20, and pnpm-8

To install the dependencies of the project you can use:

make deps

For development you may need a localhost Postgres database with database name merlin nad username and passwords postgres. You can change this configuration in development.py.

To setup the environment variables in the project you can create .env files in the root of the project. You can use this sample environment file: sample.env

To run the server on your localhost, First Make sure the environment is activated, then you can use:

make run-server

and to run the client:

make run-client

Also, you can use docker compose to run the project on docker compose. Just make sure to fix image urls(or use build) in docker compose file.

The project have two main components. The frontend part is based on Nuxt and Pey Design System. The backend part is based on Django and Django Rest Framework.

The settings and base configurations of the backend are located in the merlin directory. The backend logic is implemented in the api directory. By looking at the api/models.py You can understand the Model Structure of the project.

The code for the frontend of the project is also located in the frontend directory.

If you would like to contribute to the project, follow the guidelines in CONTRIBUTING.md.

This project is licensed under the BSD 3-Clause License.