RoBorregos Web

Front-end web app for the official RoBorregos' (international robotics team) web site.

Developed by RoBorregos' members and colaborators, in order to publish general information about the team, sponsors, news, competitions and related content.

You can consult the application on production at roborregos.com

Table of contents

• RoBorregos Web
  • Table of contents
  • Project Details
    • Development team
    • Environment URLs
  • Project setup
    • Running project
  • Devel setup

Project Details

This project is made using React.js with Material UI and React Bootstrap components. Deployment is made with DeployHQ.

For more information about project management and standards you can check our wiki.

Development team

Name	Email	Github	Role
Ivan Alberto Romero Wells	[email protected]	@IvanRomero03	PM
Lorena Martinez	@gmail.com	@	Developer
Yair Reyes	@gmail.com	@	Developer
Héctor Rubén	@gmail.com	@	Developer
Sebastián Segovia	@gmail.com	@	Developer
Emérico Pedraza	@gmail.com	@	Developer
Alexis Chapa	@gmail.com	@	Developer

Environment URLs

• Production - roborregos.com
• Preview - roborregos-web.vercel.app

Project setup

Before setting up the project, you should have installed the following development tools:

• Git
• Node.js

Once you have installed the required third-party software, you can follow this steps:

1. Clone the project repository on your local machine.

   SSH:

   $ git clone [email protected]:RoBorregos/roborregos-web.git

   or HTTPS:

   $ git clone https://github.com/RoBorregos/roborregos-web.git

2. Create the node_modules directory needed to run react apps.

   $ npm install

3. Create .env file and fill its variables.

   $ cp .sample-env .env

Running project

In your terminal, run:

$ npm start

In order to run the service in other window, just run:

$ START "" npm start

if on windows, or

$ npm start &

to run in the background, on Unix.

Use Ctrl + C to exit the logs and turn the application down.

Devel setup

For the development of the project the following tools are used:

• ESLint: Following Airbnb's style and using the es2020 standard.
• Flow: A static type checker for Javascript.
• Babel: A javascript compiler, which is required for Flow.
• Jest: The main Javascript test framework.

It is strongly recommended to use VSCode in order tu automatize some of the checks used by the tools above mentioned. For that, install the following extension:

• ESLint: to check automatically syntax errors and fix them.

NOTE: The following are not as strongly recommended, but are helpful too.

• Flow Language Support: to show flow's errors on intellisense.
• Babel ES6/ES7: it helps to visualize better the code in the most recent standard.

Once installed, everything should be running smoothly with the setting.json configuration.