reserve.io

About

reserve.io is an application for equipment reservations, making it possible to create, read, update and delete reservations.

The purpose of this application is to help maintain a workflow for reservations and evolve an old personal project that had the same goal.

This new project has a very ambitious goal of trying to use modern technologies, in addition to applying techniques and evolving personally and professionally.

Throughout this documentation I will list the technologies, architectures, structure and workflows used in this project.

I am trying my best to be the most declarative in the codes kept here, if you find any syntax error or unwanted operation, forgive me.

Att,

Jeferson Lucas

Starting

These instructions will provide a copy of the project running on your local machine.

Installing

Follow step by step the following ways to obtain the code on your local machine.

1. Start the repository on your local machine using the following command lines.

mkdir reserve.io
cd reserve.io
git init
git clone git@github.com:JefersonLucas/reserve.io.git
# or
git clone https://github.com/JefersonLucas/reserve.io.git

The files that are in the remote repository are now cloned into the local repository.

Starting server

1. Install the required server/ dependencies:

cd server/

npm install
# or
yarn install

2. Start the server on the port localhost:1010/reserve.io/v1/

npm server
# or
yarn server

3. Go to http://localhost:1010/reserve.io/v1/doc/ to view the API documentation.

Starting client

1. Install the required client/ dependencies:

cd client/

npm install
# or
yarn install

2. Start the client on the port localhost:3000

npm start
# or
yarn start

Contents

Application source code

What is included in the application.

reserve.io/
├── client/
│   ├── public/
│   └── src/
├── server/
│   ├── api/
│   ├── docs/
│   └── src/
│       ├── config/
│       ├── controllers/
│       ├── middlewares/
│       ├── pipes/
│       └── routes/
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE.md
├── logo.svg
└── README.md

Server source code

What is included in server/, including source code and precompiled.

server/
├── api/
│   └── reserve.json
├── docs/
│   ├── doc.js
│   ├── swagger.json
│   └── swagger.yaml
├── src/
│   ├── config/
│   │   └── loggerConfig.js
│   ├── controllers/
│   │   ├── reserveController.js
│   │   └── routerController.js
│   ├── middlewares/
│   │   └── reserveMiddleware.js
│   ├── pipes/
│   │   └── reservePipe.js
│   └── routes/
│       └── reserveRouter.js
├── index.js
├── nodemon.json
├── package.json
└── yarn.lock

Client source code

What is included in client/, including source code and precompiled.

client/
├── public/
│   ├── favicon.ico
│   ├── index.html
│   ├── logo36.png
│   ├── manifest.json
│   ├── robots.txt
│   └── style.css
├── src/
│   ├── App.jsx
│   ├── index.js
│   └── logo.svg
├── package.json
└── yarn.lock

Built with

The reserve.io app has been carefully developed with the following technologies:

• Technologies used on the server:

  • JavaScript - Scripting language.
  • Node.js - Javascript environment.
  • NPM - Node package manager.
  • Yarn - Package manager.
  • Express - Framework for Node.js web application.
  • Winston - Simple record library.
  • Swagger - API documentation.
  • UUID - Universal unique identifier.
  • JSON - Lightweight data exchange format.
  • Insomnia - API Client.
  • Visual Studio Code - Code editor.

• Technologies used on the client:

  • JavaScript - Scripting language.
  • Node.js - Javascript environment.
  • Yarn - Package manager.
  • Visual Studio Code - Code editor.

Contributing

Read the CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests to us.

Authors

• @JefersonLucas - Creator.

See also the complete list of contributors who participated in this project.

License

This project is licensed under the MIT license - see the file LICENSE.md for details.