Skip to content

Latest commit

 

History

History
78 lines (49 loc) · 2.51 KB

readme-en.md

File metadata and controls

78 lines (49 loc) · 2.51 KB

Discord Server | pt | en

Trilha Info

Hi 👋

If you've reached this repo it's because you're wondering how to contribute to the Trilha Info. It's pretty simple!

I am currently asking for contributions to the Frontend Roadmap. Just send a Pull Request to edit the JSON that contains all the information.

Preview

Disclaimer

The idea is to initially engage the community and then we can evolve the portal as we have the need. 😀

How to run locally?

To run the project you can simply clone/fork the project and execute the following steps:

Copy the example env variables:

cp .env.example .env.local

In the env.local file, you have the option to use a local running API or the trilha's own API, just uncomment and use whatever you find better.

Para rodar o projeto em desenvolvimento, você vai do Yarn para instalar as dependências e iniciar o servidor:

To run the project in development, you need to have Yarn installed to install the dependencies and start the server:

# Install the dependencies with:
$ yarn

# Run in developer mode:
$ yarn dev

Running with Docker:

You must have the docker-compmose installed on your computer, then execute:

# on the root of the project
docker-compose up

With the API running locally:

# reutilize the same .env.local as mentioned before, then run:
docker-compose --env-file ./.env.local up

Translations

Readme in PortugueseBrazilian Portuguese — Click here

Who has already contributed:

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT