Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/odavibatista/wits-site-webapp
Front-end stack for the sixth Hackathon of OneBitCode.
https://github.com/odavibatista/wits-site-webapp
Last synced: 26 days ago
JSON representation
Front-end stack for the sixth Hackathon of OneBitCode.
- Host: GitHub
- URL: https://github.com/odavibatista/wits-site-webapp
- Owner: odavibatista
- Created: 2024-07-16T00:05:00.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-29T02:54:10.000Z (3 months ago)
- Last Synced: 2024-07-29T07:26:04.309Z (3 months ago)
- Language: TypeScript
- Homepage: https://wits-site-webapp.vercel.app
- Size: 2.26 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🧠 Wits - WEBAPP
Bem-vindo ao projeto front-end do Wits, seu e-learning gamificado de aprendizado de raciocínio e lógica. Aqui, iremos lhe instruir em como lançar a aplicação localmente e utilizá-la.
## 📖 Índice
- [Instalação](#installation)
- [Configuração](#configuration)
- [Tecnologias Utilizadas](#techs-used)
- [Equipe](#team)
## Instalação
Para instalar o projeto, será necessário algum gerenciador de pacotes JavaScript (NPM, Yarn, PNPM, Bun...).
Primeiro, abra sua linhade comando e digite a seguinte linha:
```
git clone https://github.com/odavibatista/wits-site-webapp.git
```
E em seguida:
```
cd wits-site-api
```
Já na root do projeto, baixe as dependências com o seu comando de instalação (com base noseu gerenciador de pacotes):
```
npm install
yarn install
bun install
```
Após instalar as dependências, é preciso configurar as variáveis de ambiente do mesmo. Para isso, faça uma cópia do arquivo `.env.example` presente na root do projeto e nomeie-o para `.env`.
Dentro dele, você encontrará o seguinte esqueleto de variáveis presente:
```
# Do not forget to use "http" instead of 'https' for local development
BASE_URL= (A URL LOCAL DO FRONT-END)
NEXT_PUBLIC_API= (A URL DA API, UTILIZAR SOMENTE "http" AO INVÉS DE "https" CASO SUA API SEJA LOCAL)
```
Ao preenchermos a `.env` corretamente, teremos algo similar a isso:
```
# Do not forget to use "http" instead of 'https' for local development
BASE_URL="http://localhost:3000/"
NEXT_PUBLIC_API="http://localhost:5000/"
```
Após isso, podemos enfim lançar o projeto:
```
npm run dev
yarn dev
bun dev
```
Acessando a URL fornecida pelo Next, poderemos utilizar a aplicação, integrada com a API.
## Tecnologias Utilizadas
- [Axios](https://www.npmjs.com/package/axios)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/gettingstarted/)
- [ESLint](https://eslint.org/)
- [Framer Motion](https://www.npmjs.com/package/framer-motion)
- [Jose](https://www.npmjs.com/package/jose)
- [Lucide React](https://lucide.dev/guide/packages/lucide-react)
- [NextJS](https://nextjs.org/)
- [NextUI](https://nextui.org/)
- [Prettier](https://www.npmjs.com/package/prettier)
- [React](https://react.dev/)
- [Sonner](https://www.npmjs.com/package/sonner)
- [TailwindCSS](https://tailwindcss.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [Zod](https://zod.dev/)
- [Bruno Almeida](https://github.com/thenrybruno)
- [Davi Batista](https://github.com/odavibatista)
- [Thiago Magno](https://github.com/thgmagno)