Home

Welcome to the pallas documentation

This documentation provides all the information needed to interact with the Pallas API. It includes detailed information about the available routes, request and response formats, and any authentication or authorization requirements.

The documentation is organized by resource, with each resource having its own page that lists all available routes for that resource. There are also sections for general information about the API, such as authentication and error handling.

Please use the navigation menu on the left to explore the documentation. If you have any questions or feedback, please open an issue on the GitHub repository.

How to run the project locally

This project is designed for ease of execution and contribution, and you can run it locally with the following steps.

1. Clone the repository:

git clone https://github.com/miguel5g/pallas.git
cd pallas

2. Install dependencies:

npm install

3. Set up environment variables:

cp .env.example .env.development

Note: Fill in the required values in the .env.development file.

4. Start the development containers:

npm run docker:dev:up

5. Launch the project:

npm run start:dev

Congratulations! The project is now running and accessible at the following URLs and servers:

• API: http://localhost:4000
• SMTP Client: http://localhost:1080
• SMTP Server: smtp://localhost:1025
• MySQL Container: mysql://root:pallas@localhost:3306/pallas

Enjoy using the project!

How to contribute to the project

We appreciate contributions to this project and are grateful for your help in making it better. Here's how you can get started:

1. Fork the repository:

Click the "Fork" button in the upper-right corner of the repository page to create a copy of the project in your own GitHub account.

2. Clone the repository:

git clone https://github.com/[YOUR_USERNAME]/pallas.git
cd pallas

3. Create a new branch:

git checkout -b [BRANCH_NAME]

4. Make changes and commit them:

Make your changes to the code and commit them with a descriptive message.

5. Push the changes to your forked repository:

git push origin [BRANCH_NAME]

6. Create a pull request:

Go to the original repository page and click the "New pull request" button. Choose the branch you just submitted and submit the pull request with a description of your changes.

We'll review your changes and discuss them with you before merging them into the main codebase. Thanks for contributing!