TutorMatch

Tutor Match a simple project using NodeJS, OAS 3.0, Swagger, Angular 6.0, SQLite and Sequelize.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Angular CLI: 6.0.8
Node: 8.11.3
npm: 5.6.0
Nodemon: 1.18.3
Docker: 18.06.0

Installing

If you use Docker, you just need exec $ docker-compose up to use this project.

$ git clone https://github.com/vitorpsilva/TutorMatch.git

Running with Angular CLI

$ cd TutorMatch/tutormatch_front
$ npm install
$ ng serve

Running NodeJS

$ cd TutorMatch/tutormatch_back
$ npm install
$ nodemon --exec npm start OR $ npm start

Running with Docker Compose

cd TutorMatch/
$ docker-compose up

Using the app

Frontend - Tutor Match Frontend - http://localhost:8080

Backend - API Catalog - http://localhost:3000

Built With

NodeJS - Asynchronous event driven JavaScript runtime
Docker - Container
Angular CLI - DevKit Tools

Versioning

Please, see the tags on this repository.

Authors

Antonio Vitor - vitorpsilva

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

License

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