Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rafaelgoulartb/nlw-valoriza

๐Ÿš€ NLW Together - NodeJS @Rocketseat
https://github.com/rafaelgoulartb/nlw-valoriza

back-end nlw nlw-6 nlw-together node nodejs rocketseat

Last synced: 3 months ago
JSON representation

๐Ÿš€ NLW Together - NodeJS @Rocketseat

Awesome Lists containing this project

README

        

NLW Valoriza



Rafael Goulart

Repository size

GitHub last commit

License

Stargazers

> :rocket: Project made to connect teachers to students, made in Next Level Week #2 @Rocketseat


English
ยท
Portuguese


The NLW #4 project. Built with โค๏ธŽ by
Rafael Goulart and

contributors


# :pushpin: Table of Contents

* [Technologies](#computer-technologies)
* [Features](#rocket-features)
* [How to Run](#construction_worker-how-to-run)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)

# :computer: Technologies
This project was made using the follow technologies:

* [NodeJS](https://nodejs.org/en/)
* [Express](https://expressjs.com/)

# :rocket: Features

* Website to sign up teachers and students.
* App to connect teachers and students.

# :construction_worker: How to run
```bash
# Clone Repository
$ git clone https://github.com/RafaelGoulartB/nlw-valoriza.git
```
### ๐Ÿ“ฆ Run API

```bash
# Go to server folder
$ cd nlw-valoriza

# Install Dependencies
$ yarn install

# Run Migrations
$ yarn typeorm migration:run

# Run Aplication
$ yarn run dev
```
Access API at http://localhost:3333/

# :bug: Issues

Feel free to **file a new issue** with a respective title and description on the the [nlw-valoriza](https://github.com/RafaelGoulartB/nlw-valoriza/issues) repository. If you already found a solution to your problem, **i would love to review your pull request**!

# :tada: Contributing
First of all, thank you for being interested in helping out, your time is always appreciated in every way. :100:

Here's some tips:

* Check the [issues page](https://github.com/RafaelGoulartB/nlw-valoriza/issues) for already opened issues (or maybe even closed ones) that might already address your question/bug/feature request.
* Feature requests are welcomed! Provide some details on why it would be helpful for you and others, explain how you're using bull-board and if possible even some screenshots if you are willing to mock something!

Check out the [contributing](./CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.

# :closed_book: License

Released in 2020 :closed_book: License

Made with love by [Rafael Goulart](https://github.com/RafaelGoulartB) ๐Ÿš€.
This project is under the [MIT license](./LICENSE).

Give a โญ๏ธ if this project helped you!