Dolos

A handy data mocking api to generate data in given schema

Ever wanted to get random data for that app you were building, say no more. Dolos, the god of deception and trickery is here for you.

Contribute

To take part in the development of this project, refer the github projects board. We have setup beginner level issues, and labelled them as well ! Feel free to claim any issue (or open a new one) and contribute to the development of the project.

Usage

To setup project locally, fork the repository.

# install dependencies
npm install

# run the server
npm run start:dev

Docker

🐳 Run and develop through Docker (Optional)

The docker-compose.yml file contain:

phpMyAdmin: *For database manager.**
MySQL: The database itself
Dolos: The Dolos application
Portainer: To monitoring your container services, such as logs, restart and more.

For development, you can run the Dolos using Docker Compose by following this steps below:

Adjust .env with some dependencies variables.
Run docker-composer up -d for build all containers and prepare them to the first run.
Run docker-composer up and that's it, let's code!
If you want to stop, run docker-compose down

The IP address to use:

- phpMyAdmin: 0.0.0.0:8081
- Dolos: 0.0.0.0:3000
- Portainer: 0.0.0.0:9000

To connect on Portainer, do the follow steps:
1. You'll need to create a password for local admin account.
2. Choose the option: "Docker manage the local Docker environment".
3. Done, you're now able to manage the containers.

Contribution

Readup the detailed plan of the project and how to contribute here.