Skip to content

💾 Server - API RESTful com NodeJS para manipular todos os dados da plataforma online de estudos Proffy.

License

Notifications You must be signed in to change notification settings

LuizCarlosVilela/nlw-2-backend

Repository files navigation

Proffy Back-end

Proffy Banner

📚 Proffy é um projeto Open Source desenvolvido na semana Next Level Week (2.0) da Rocketseat utilizando as tecnologias TypeScript, Node, React e React Native.

Proffy Back-end

🚀 OBJETIVO

O projeto tem como finalidade estabelecer uma conexão entre os professores (Proffys) e os alunos que desejam um professor com qualificação para dar orientações e aulas sobre determinada matéria. Solucionando então um problema de comunicação entre professores que queira dar aulas, e alunos que desejam um professor para orientar nos estudos em diversas áreas.

💻 TECNOLOGIAS

💾 Server (NodeJS + TypeScript)

Arquivo json do Back-end package.json

Utilitários

🍷 COMO UTILIZAR

Configurações Iniciais

Primeiro, você precisa ter o NodeJS instalado na sua máquina.

Se você estiver utilizando o Linux, você pode optar por instalar o Node através do gerênciador de versões asdf para facilitar o processo de mudança da versão do Node, quando for necessário.

Você pode optar também por utilizar o yarn no lugar do npm. Você pode instalar clicando nesse link, ou através do asdf.

Instale as dependências contidas nos arquivos package.json que se encontram na raíz do repositório (para o gerenciamento de commits), no diretório do server. Para instalar as dependências, basta abrir o terminal no diretório e digitar o comando:

$ npm install

# ou
$ yarn

Exemplos:

# Instalando as dependências do commitlint:
$ cd ./proffy
$ npm install

# Instalando as dependências do server:
$ cd ./sources/server
$ npm install

Veja os arquivos package.json do commitlint, server, website e mobile.

Utilizando o Server

# Abrindo o terminal no diretório do servidor:
$ cd ./sources/server

# Executando a aplicação em modo de desenvolvimento:
$ npm run dev

# Instanciando o banco de dados:
$ npm run knex:migrate

# Povoando o banco de dados (seeds):
$ npm run knex:seed

Veja a parte de scripts {} do arquivo package.json para saber quais scripts estão disponíveis.

📚 REFERÊNCIAS

📃 LICENÇA

Este repositório está licenciado pela MIT LICENSE. Para mais informações detalhadas, leia o arquivo LICENSE contido nesse repositório.

Feito com ❤️ por Luiz Carlos Vilela