https://github.com/samuel-ricardo/tutorialls_website

https://github.com/samuel-ricardo/tutorialls_website

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/samuel-ricardo/tutorialls_website
• Owner: Samuel-Ricardo
• License: mit
• Created: 2024-08-28T11:34:05.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-09-03T03:31:29.000Z (9 months ago)
• Last Synced: 2025-01-14T12:43:34.953Z (5 months ago)
• Language: TypeScript
• Homepage: https://tutorialls-website.vercel.app
• Size: 16.1 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tutorialls Website

![363455571-245de160-69be-4ba8-ba59-23ecb592c169](https://github.com/user-attachments/assets/5ab4c18b-cb1e-4acc-9d26-24ff050b796f)

🚀 🟩 Emlpoyee Dashboard 🟩 🚀




  Application developed for explore my dev skills



#



  |  

  Overview   |   

  Technologies   |   

  Project   |  

  Run   |  

  Author   |   



#



  

  

    

  


  

     

  

  

     

  











  | :artificial_satellite: About:  




This is a full stack tutorial platform that allows you to consume tutorials and search with filters, being able to delete them, edit them or register new tutorials using the best programming practices and clean code, such as Clean Architecture and Hexagonal Architecture.






🔭 | API Repository: [[Tutorialls-API](https://github.com/Samuel-Ricardo/Tutorialls_API)] 


📡 | Hosted on Vercel: [https://tutorialls-website.vercel.app/](https://tutorialls-website.vercel.app/)




#






  :building_construction: | Technologies and Concepts Studied:



>   

- NextJS 14

- Docker

- Sanity CMS

- TailwindCSS

- Typescript

- Jest

- Cypress

- Inversify

- MongoDB

- Zod

- Validations

- React-Hook-Forms

- React-Query - [ @tanstack ]

- Axios

- eslint

- Prettier

- husky

- lint-staged

- Caching

- Clean Architeture

- Scalability

> Among Others...

#






  💻 | Application:



### ✋ | Welcome Page:

![362781868-de67a45b-0f7c-423a-be7b-2a01605d6dc7](https://github.com/user-attachments/assets/90f12d93-1fe5-4e07-b8c4-9d40a82dd8fe)



  Welcome page, uses Sanity to provide static content, such as images via CDN, texts and the like, increasing the performance of a real application and opening doors for content internationalization, redirects to login



### 🛂 | Login:

![362782353-474d5df9-6b1b-42e3-9fa7-1e584a7b658b](https://github.com/user-attachments/assets/cb0d3fdf-f096-434c-a325-e2ca3a8ca9ff)

![362782495-98e37b44-249d-497b-913c-4790ff096611](https://github.com/user-attachments/assets/f62a7d3d-5c5d-4233-8a70-af5aeea0c2c0)



 Login page, identifies if you are already logged in and automatically redirects to the "/tutorials" page, otherwise you can sign up with a modal or log in with your credentials, all of this has real-time data validation



### 🔎 | Seach Page

![363455571-245de160-69be-4ba8-ba59-23ecb592c169](https://github.com/user-attachments/assets/b37d2a6b-aa8a-41c1-bcd6-fd6d1673871c)



  Esta página lista todos os tutoriais e permite fazer uma busca filtrando por titulo, autor e palavra-chave dentro do conteudo, conta com uma otimização que cacheia as pesquisas já feitas, por aqui você também pode criar, atualizar e deletar tutoriais.



![363455553-9ca0eac9-3e37-41f7-a1da-f9e0db8335c1](https://github.com/user-attachments/assets/94bedc34-cc8a-437c-98d7-6ef74171ae88)

![363455623-04d3adc7-3456-4049-9208-d3ca4425cd2d](https://github.com/user-attachments/assets/ab9d8ac7-4837-4e9a-978d-b355d2dd121a)



  Conta com uma Barreira de autenticação que te redireciona para o login caso não esteja logado.



![363455747-52f579a3-4e05-4272-84cb-7afe023be5f8](https://github.com/user-attachments/assets/81be9fc3-5995-47cc-b19c-558d07432e8d)

### 📱 | Responsividade

![image](https://github.com/user-attachments/assets/2b115aa7-5611-4595-9e7c-8c210d225f2b)

### 📊 | Performance

![image](https://github.com/user-attachments/assets/a85a3f12-b61b-4358-9d94-9bd7f3c04f4a)

![image](https://github.com/user-attachments/assets/a9117d2c-1209-4a39-9299-ea3b836a446f)




🔭 | API Repository: [[Tutorialls-API](https://github.com/Samuel-Ricardo/Tutorialls_API)] 


📡 | Hosted on Vercel: [https://tutorialls-website.vercel.app/](https://tutorialls-website.vercel.app/)




 

   👨‍💻 | How to use






### Open your Git Terminal and clone this repository

```git

  $ git clone "[email protected]:Samuel-Ricardo/tutorialls_website.git"

```

### Make Pull

```git

  $ git pull "[email protected]:Samuel-Ricardo/tutorialls_website.git"

```




This application use `Docker` so you dont need to install and cofigurate anything other than docker on your machine.

>   




- Navigate to project folder `$ cd ./tutorialls/` 




- Create a `.env` & `.env.local` files based on .env.*.example files

- Now run it using `docker-compose`

```bash

  # After setup docker environment just run this commmand on root project folder:

  $ docker-compose up --build   # For First Time run this command

  $ docker-compose up           # to run project

```

```bash

  #Apps Running on:

  $ SITE: http://localhost:3000

  $ API: http://localhost:3001

  $ POSTGRESQL: http://localhost:27017 | [DATABASE]

  $ PGADMIN: http://localhost:5050/    | [DB DASHBOARD]

  $ RABBITMQ: http://localhost:15672/  | [MQ DASHBOARD]

  $ REDIS: 6379                        | [CACHE] 

  See more: ./tutorialls/docker-compose.yaml

```




You also can use the Docker Image:

```docker

$ docker pull ghcr.io/samuel-ricardo/tutorialls_website:main

```

```Dockerfile

$ FROM ghcr.io/samuel-ricardo/tutorialls_website:main

```

#






  :octocat: | Author:  



>   
 
  - Samuel Ricardo