Api Cas Entertainment

Api Rest Para administrar eventos y registrar usuarios.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Install docker
• Install git
• Install nodejs
• Install nvm

Installing

To install cast entertainment api, follow these steps:

• Clone the source locally:

   $ git clone https://github.com/Alver23/cast-entertainment-api.git
   $ cd cast-entertainment-api

Using with docker

To use cast entertainment api, follow these steps:

• Run the following command:

   $ cd cast-entertainment-api
   $ ./docker-run.sh

Using with machine local

To use cast entertainment api, Note that the "Mysql" database container must be running, then follow these steps:

• Enter the project folder:

   $ cd cast-entertainment-api

• Add the .env file:

   $ touch .env

• Installing dependencies:

   $ npm i

• Add environment variables:

   $ npm run env:dev

• Generate the application build:

   $ npm run build

• Run the migrations to create the tables:

   $ npm run db:migrate

• If you do not have data in the application, run the migration of the seeders:

   $ npm run db:seed

• Initialize the application:

   $ npm run start

Api documentation

• Postman

Contributing

To contribute to cast entertainment api, follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin <project_name>/<location>
5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Contributors

• @Alver23 📖

Contact

If you want to contact me you can reach me at viga.23@hotmail.com.