OpenContractMX

Description

This respository contains de Frontend code of the project, this includes all the components, pages, assets and their respective tests.

If you want to check the Backend repository, go here. If you want to check the Data Science repository, go here.

Project Summary

OpenContractMX is a project developed by Platzi Master Students in order to catch more than 350,000 public contracts published by the Government of Mexico and show them in a easy way for reporters, researchers and similars so they can get great information about how the goverment spents in the different areas

Built With

• React
• Sass
• Axios
• Recharts

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

or

npm install --global yarn

Clone the project

  git clone https://github.com/OpenContractMX/Frontend.git

Go to the project directory

  cd Frontend

Install dependencies

  npm install

or

  yarn install

Start the server

  npm run start

or

  yarn start

Screenshots

This menu allows navigation through the web app.

At Inicio(Home's page) you could find a quick instruction list for app's usage.

At Estadística(Statistic's page) you could interact with the app making a contracts search by category and year.

At Sobre Nosotros(About Us's page) you could find info about developers that made this app.

Running Tests

To run tests, run the following command

  npm run test

Deployment

We deployed the Frontend application in Netlify, you can find the link here.

If you want to see the Backend deployment that it is using this Frontend, please go here.

License

Distributed under the MIT License. See for more information.