Skip to content

Latest commit

 

History

History
98 lines (75 loc) · 7.32 KB

README-en-US.md

File metadata and controls

98 lines (75 loc) · 7.32 KB

English (US) | Português (BR)

Querido Diário

Frontend (web interface)

Within the Querido Diário ecosystem, this repository is responsible for the Querido Diário website.

Learn more about the project’s technologies and history.

Table of contents

How to contribute

catarse

Thank you for considering contributing to Querido Diário! 🎉

You can find how to do it at CONTRIBUTING-en-US.md!

Also, check the Querido Diário documentation to help you.

Development environment

The project uses Node.js and Yarn. We also use nvm, a node.js version manager. To see the node.js version, the list of dependencies, and their versions, see the package.json file.

With a terminal opened in the root directory of the repository, use the following sequence of commands to install all these tools on a Linux operating system:

nvm install v16.2.0
npm install --global yarn
yarn

To learn more details or information about setting up on other operating systems see "how to set up the development environment".

How to run

  1. With the terminal opened in the root directory of the repository, the project can be served locally with the command:
yarn ng serve
  1. During execution, a log will appear in the terminal. The final part, like the following, informs which port the site is being hosted on.
** Angular Live Development Server is listening on localhost:4200, open your browser on http://localhost:4200/ **

✔ Compiled successfully.
  1. Done! Now you can simulate the changes and see how the modifications made in the code are reflected on the site before sending your contribution!

Support

Discord Invite

Join our community channel to exchange ideas about the projects, ask questions, request help with contributions, and discuss civic innovation in general.

Acknowledgments

The application was initially developed with the team at the software studio Jurema.

This project is maintained by Open Knowledge Brasil and made possible by technical communities, Civic Innovation Ambassadors, volunteers, financial donors, partner universities, and supporting and sponsoring companies.

Meet those who support Querido Diário.

Open Knowledge Brazil

Bluesky Follow Instagram Follow LinkedIn Follow Mastodon Follow

Open Knowledge Brazil is a nonprofit civil society organization whose mission is to use and develop civic tools, projects, public policy analysis, and data journalism to promote open knowledge across various fields of society.

All work produced by OKBR is freely available.

License

Code licensed under the MIT License.