docs: add documentation

add documentation, formatting and
stylization.

.gitignore

@@ -1,2 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
 node_modules
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
 .env
+.vscode
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

README.md

@@ -0,0 +1,56 @@
+<h1 align="center">
+<br>
+  <img src="src/assets/images/logo-interna.svg" alt="GoBarber" width="90">
+<br>
+<br>
+GoBarber
+</h1>
+
+<p align="center">GoBarber - Backend API REST with NodeJS and Express</p>
+<p align="center">Project based on a scheduling service for barbers promoting control, organization and convenience to their customers.</p>
+
+<p align="center">
+  <a href="http://makeapullrequest.com">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome">
+  </a>
+  <a href="https://opensource.org/licenses/MIT">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="License MIT">
+  </a>
+</p>
+
+<hr />
+
+## **Software Architecture**
+
+This app features all the latest tools and good practices in web development.
+
+- [**NodeJS**](https://nodejs.org/en/) — *Javascript interpreter.*
+- [**Postgres**](https://www.postgresql.org/) — *SQL database.*
+- [**MongoDB**](https://www.mongodb.com/) — *NoSQL object data model.*
+- [**Redis**](https://redis.io/) — *NoSQL key-value data model.*
+
+## **Libraries**
+
+Libraries featured in this project.
+
+- [**Express**](https://expressjs.com/pt-br/) — Micro framework (HTTP/REST) for NodeJS.
+- [**Bcryptjs**](https://www.npmjs.com/package/bcryptjs) — Security passwords salty encode.
+- [**Bee-queue**](https://github.com/bee-queue/bee-queue) — Job/task queue for NodeJS.
+- [**Sequelize**](https://sequelize.org/) — SQL Dialect/ORM for NodeJS.
+- [**Nodemailer**](https://nodemailer.com/about/) — Library to send e-mails with NodeJS.
+- [**Yup**](https://github.com/jquense/yup) — Object schema validator.
+- [**Sentry**](https://sentry.io/) — Cross-platform application monitoring.
+- [**Date-fns**](https://date-fns.org/) — Library to easily manipulate date's with NodeJS.
+- [**Dotenv**](https://www.npmjs.com/package/dotenv) — Library to manipulate variables about the application.
+- [**Jsonwebtoken**](https://www.npmjs.com/package/jsonwebtoken) — Security authentication using JWT
+- [**Mongoose**](https://www.npmjs.com/package/mongoose) — NoSQL Dialect/ODM(MongoDB) for NodeJS
+- [**Multer**](https://www.npmjs.com/package/multer) — Middleware library to multipart/form-data
+- [**Youch**](https://www.npmjs.com/package/youch) — A strucuture HTML/JSON for errors
+
+## Getting started
+
+1. Clone this repo using `https://github.com/w-arantes/gobarber-backend.git`
+2. Move to the appropriate directory: `cd gobarber-backend`.<br />
+3. Run `yarn` to install dependencies.<br />
+4. Run `yarn start` to see the example app at `http://localhost:3000`.
+