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 or roborregos.mx.

Table of contents

• RoBorregos Web
  • Table of contents
  • Project details
    • Development team
    • Environment URLs
    • Management tools
  • Development
    • Setup
    • Running the stack for development
    • Stopping services

Project Details

Development team

Name	Email	Github	Role
José Eduardo Sánchez	gallo.sanchez23@gmail.com	@gallosanchez23	PM & Developer
Sebastián Rivera González	sebas.rivera96@gmail.com	@sebasrivera96	Developer
Aurora Tijerina Berzosa	auro.tj@gmail.com	@aurotb	Developer
Ricardo Chapa Romero	ricardochaparomero@gmail.com	@RicardoChapaRomero	Developer
José Alfonso Cisneros	joseacisnerosm@gmail.com	@Josecisneros001	Developer
Omar Ulises Montiel	omarume@gmail.com	@OUMontiel	Developer
Clara Gutiérrez Jaime	claragtzjaime@gmail.com	@ClaraGtz	Designer & Developer
Ana Lucía Garza	analuciagarzamtz@gmail.com	@AnaGarza	Designer

Environment URLs

• Production - roborregos.com

Management tools

You should ask for access to these tools if you don't have it already:

• Github repo
• Heroku
• InVision
• Google Drive

Development

Setup

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

• Git
• Docker
• Docker Compose
• Plis (optional, but highly recommended)
• Yarn

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 git@github.com:gallosanchez23/roborregos-web.git

   or HTTPS:

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

2. You will need to create the node_modules directory needed to run react apps.

   $ yarn install

3. Create the Docker image.

   plis:

   $ plis build

   docker-compose:

   $ docker-compose build

Running the stack for development

In your terminal, run:

plis:

$ plis start frontend-web && plis attach frontend-web

docker-compose:

$ docker-compose up

This command will start the frontend application and display the logs on your terminal. Use Ctrl + C to exit the logs and turn the application down. Otherwise, in order to run the service in the background, just run:

plis:

$ plis start frontend-web

docker-compose:

$ docker-compose up -d

If the service is already running, you can run the command plis attach frontend-web to attach current service's logs.

NOTE: You can allways run plis run frontend-web bash or docker-compose run frontend-web bash commands to enter the container's console.

Stopping services

In order to stop roborregos-frontend-web entirely you can run:

plis:

$ plis stop

docker-compose:

$ docker-compose stop

If you want to stop the services and remove the containers:

plis:

$ plis down

docker-compose:

$ docker-compose down

If you only want to stop one service in particular, you can specify it with the following command:

plis:

$ plis stop frontend-web

docker-compose:

$ docker-compose stop frontend-web