otaldonunes / btf-nesse-som

Website BTF Nesse Som

Boto Fé Nesse Som

Website CRUD responsivo, com CMS.

🚧 Work in Progress 🚧

Protótipo cedido gentilmente pela .comUNIQUÉ, responsável pela concepção e criação de todo layout/ui/ux, para que eu pudesse demonstrar minhas hábilidades de desenvolvimento. (P.s.: os códigos aqui presentes não refletem o projeto final em produção desenvolvido pela empresa e são exclusivamente meus, também tomei a liberdade de realizar algumas modificações que julguei pertinentes)

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Features
4. Assets
5. Contributing
6. Contact

😊 About The Project

⚡ Built With

• TypeScript
• Next.js
• Styled-components
• Polished
• React Query
• FaunaDB
• axios
• yup
• React Hook Form
• React-Toastify

(back to top)

🚀 Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Yarn

  npm install -g yarn

Installation

1. Clone the repo

   git clone -b devel [e-mail]:otaldonunes/btf-nesse-som.git

2. Install Yarn packages

   yarn

3. Create a .env.local file in root directory and enter your API keys in .env.local

   # FaunaDB:
   FAUNADB_KEY='API_KEY'
   FAUNADB_DOMAIN="FAUNA_DOMAIN"
   
   # JWT
   JWT_SECRET="JWT_SECRET"

4. Start development server

   yarn dev
   

(back to top)

💫 Features

• Página Home
• Página de Publicações
• Página de Podcasts
• Página de Vídeos
• Página de Lançamentos da Semana
• Página Sobre
• Integração com Rádio Online
• Página de Autenticação
• Área Administrativa com CMS

(back to top)

📁 Assets

1. Figma

   https://www.figma.com/file/eEaBIRb1nyxkwiUVYD0Vui/BOTO-F%C3%89-NESSE-SOM
   

(back to top)

🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated, like:

• ⭐️ Star the project
• 🐛 Find and report issues
• 📥 Submit PRs to help solve issues or add features

If you have a suggestion that would make this better, please clone the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Note: Please use Conventional Commits!

• chore:
• feat:
• fix:
• refactor:
• docs:
• perf:
• style:
• test:
• build:
• ci:
• env:

1. Clone the Project
2. Create your Feature Branch (git checkout -b prefix/Subject)
3. Commit your Changes (git commit -m 'prefix: subject')
4. Push to the Branch (git push origin prefix/Subject)
5. Open a Pull Request

(back to top)

✉️ Contact

Made with ❤️ by Arthur Nunes - @otaldonunes - [e-mail]

Project Link: https://github.com/otaldonunes/btf-nesse-som

(back to top)