DayPay

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Working conventions
4. Roadmap
5. License
6. Acknowledgements

About The Project

Built With

• React
• Express

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

• docker

https://docs.docker.com/engine/install/ubuntu/

Installation

1. Clone the repo

   git clone https://github.com/raulsalcedo03/DayPay-react.git

2. Install NPM packages

   npm install

3. Clone the backend repo

   git clone https://github.com/raulsalcedo03/DayPay-node.git

4. Install backend NPM packages

   npm install

5. Setup MongoDB image using docker:

   sudo docker run -d -p 127.0.0.1:27017:27017 --name DayPay-node \
    -e MONGO_INITDB_ROOT_USERNAME=mongoadmin \
    -e MONGO_INITDB_ROOT_PASSWORD=secret \
    mongo

6. Run the mongo image in docker:

sudo docker start DayPay-node

7. Start the backend server:

npm start

8. Start the frontend server:

npm start

Working Conventions

We will use camelCase for all naming conventions.
When creating class names, if the class is a container we will name it according to what will be contained followed by __container. eg:

<div className="trustBox__container">trustBox</div>

Branches will be named after the developer and the feature being developed. eg:

raulSalcedo-user-API

Pull request have to be reviewed by two team members before merging and have to be tested berfore commiting the changes.

Usamos camelCase para todos los nombres.
Al crear cajas contenedoras para añadiremos __container al final del nombre de la siguiente manera:

<div className="trustBox__container">trustBox</div>

Nombraremos las ramas en funcion de quien essta trabajando en ella y de la feature a trabajar. Por ejemplo:

raulSalcedo-user-API

Las pull request tienen que ser revisadas por lo menos por dos miembros del equipo.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contact

Raul Salcedo - raul.salcedo03@hotmail.com
Marcos Andaluz de Rosas - mandaluzr@hotmail.com
Felipe Meira - f.zende@gmail.com
Richard Perdomo - richard.perdomo121@gmail.com
Adrià Santos - adria@santos.cat
Alejo Viñeta - avinetam@gmail.com

Project Link: https://github.com/raulsalcedo03/DayPay-react

Acknowledgements

• Readme template