Giter Site home page Giter Site logo

plann.er's Introduction

Plann.er

GitHub language count GitHub Top Language Repository size

Capa do projeto

💻 Sobre

Este é o repositório do Plann.er, que é um sistema de planejamento de viagens, onde é possível montar planos de viagens com amigos. É possível cadastrar atividades, adicionar links úteis sobre a viagem, entre outras funcionalidades.

Essa aplicação foi desenvolvida durante o evento Next Level Week Journey da Rocketseat utilizando principalmente tecnologias como Node, TypeScript, Fastify e React.

⚙ Instalação

📝 Requisitos

Antes de baixar o projeto é necessário ter as seguintes ferramentas já instaladas:

Utilize uma ferramenta como Postman, ou outra similar, para testar as rotas da aplicação sem o frontend.

Configuração

Passo a passo para clonar e executar a aplicação na sua máquina:

# Clone este repositório
$ git clone https://github.com/campagnuci/plann.er

# Acesse a pasta do projeto no terminal
$ cd plann.er

# Acesse a pasta do backend:
$ cd backend

# Instale as dependências
$ npm install

# Crie o arquivo '.env' e preencha as variáveis conforme o arquivo '.env.example'
cp .env.example .env

# Execute as migrations para criar as tabelas necessários no banco
$ npx prisma migrate dev

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

# A aplicação inciará na porta que você configurou no arquivo '.env'
# Volte para o diretório anterior e acessa a pasta do frontend
$ cd ../frontend

# Instale as dependências
$ npm install

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

# A aplicação inciará na porta padrão do vite, 5173

Documentação

Após o servidor backend estar rodando, é possível acessar ele através da rota /docs na aplicação. Caso tenha utilizado a porta padrão, 3333, o endereço será: http://localhost:3333/docs

🛠 Tecnologias

As seguintes libs foram usadas na construção do projeto:

Backend

Frontend

Para mais detalhes das dependências gerais da aplicação veja os arquivos de cada componente da aplicação backend e frontend

plann.er's People

Contributors

campagnuci avatar vcampagnuci avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.