Giter VIP home page Giter VIP logo

pb_24e1_5's Introduction

PB_24E1_5

Note

Projeto de Bloco: Desenvolvimento Front-end com Frameworks

✨ Descrição

O projeto escolhido pelo professor é um fórum gamificado.

Nesta plataforma o usuário poderá postar e responder tópicos, recebendo pontos e recompensas por sua participação.

🎯 Objetivos

O objetivo é desenvolver uma plataforma que permita que seus usuários criem e participem em tópicos de interesse.

É importante:

  • Permitir o registro de novos usuários com dados pessoais.

  • Oferecer acesso à plataforma para usuários cadastrados.

  • Permitir que usuários não cadastrados visualizem tópicos populares.

  • Criar tópicos com informações relevantes.

  • Comentar em tópicos existentes.

  • Curtir ou descurtir tópicos e comentários.

  • Atribuir pontos a cada ação do usuário.

  • Implementar um sistema de ranking para mostrar os usuários com mais pontos.

🚀 Como usar

Important

Este projeto utiliza Supabase.

É necessário criar uma conta e iniciar um projeto (gratuito) para utlilizar o banco de dados e o serviço de autenticação.

Também é possível utilizar localmente ou em seu servidor fazendo self-hosting

Siga as intruções no site.

Você pode rodar o projeto localmente ou com Docker.

Tip

É recomendado rodar o projeto com Docker para evitar problemas com dependências e configurações locais.

Rodando com Docker

Para rodar o projeto com Docker, você precisará ter instalado:

  1. Clone este repositório

     git clone https://github.com/xnatsuk/PB_24E1_5.git
  2. Acesse a pasta do projeto

    cd PB_24E1_5
  3. Defina suas variáveis de ambiente

    Crie seu próprio arquivo .env com suas keys do Supabase. Veja o .env.example

  4. Execute o comando para subir o container

    docker-compose up -d
  5. Acesse o projeto

    client: http://localhost:3000

    api docs: http://localhost:5000/docs

Rodando localmente

Para rodar o projeto localmente, você precisará ter instalado:

  1. Clone este repositório

    git clone https://github.com/xnatsuk/PB_24E1_5.git
  2. Acesse a pasta do projeto

    cd PB_24E1_5
  3. Instale as dependências e inicie o client

    cd client
    pnpm install
    pnpm dev
  4. Instale as dependências

    cd ..
    cd backend
    poetry install --no-root
  5. Inicie a API

    Para desenvolvimento:

    poetry run fastapi dev src/main.py --port 5000
    

    Para produção:

    poetry run fastapi run src/main.py --port 5000
    
  6. Acesse o projeto

    client: http://localhost:3000

    api docs: http://localhost:5000/docs

pb_24e1_5's People

Contributors

xnatsuk avatar

Watchers

 avatar

pb_24e1_5's Issues

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.