Skip to content

Latest commit

 

History

History
204 lines (135 loc) · 5.15 KB

readme.md

File metadata and controls

204 lines (135 loc) · 5.15 KB
Raw

Plann.er

Author Version Languages Stars Forks Contributors

📌 Table of Contents

🏠 About

This application is used to create a complete agenda for a trip, including its activities, participants and important links. It has confirmation emails for the trip and its participants, as well as notifications of updates to the data registered for the trip.

To the front-end:

Vite to manage the entire application.

Vitejs plugin react swc to speed up the build and auto reload in dev of the application.

Typescript as a programming language used through the reactJs framework and transpiled to javascript.

React dom to route application navigation.

React router dom with localforage, match sorter and sort by to create application navigation.

Axios to make requests to the application back-end.

Date fns to format dates.

React day picker to use date picker component.

TailwindCss together with postcss and autoprefixer to style the web application.

Tailwind variants to create variables in styled components using Tailwind.

Lucide react for icon use in react.

To the back-end:

Typescript as a programming language used through the nodeJs framework and transpiled to javascript.

Fastify as a server and fastify cors for cors configuration.

Tsx to manage all the auto-reloading of the application in the application dev.

Tsup to speed up the build.

Zod along with the fastify type provider zod to perform validations on routes and environment variables.

Prisma and prisma client to connect and use the database in the application.

Nodemailer to send emails.

DayJs to format dates.

Common to the project:

BiomeJs for formatting and linting the code.

Husky and lint-staged to automate tasks during git flow.

Access the project:

The front-end via the link.

The back-end via the link.

🎯 Installation

First you need to install:

Then in order, clone the project.

By HTTPS, running this command:

  git clone https://github.com/LeoMSSilva/plann.er.git

Or by ssh, running this command:

  git clone git@github.com:LeoMSSilva/plann.er.git

SSH is a secure protocol, but you need to register a key ssh in your github before.

🛠️ Install dependencies

  yarn

or

  yarn install

🚀 Getting Started

To run the front-end use:

  cd web

Or to run the back-end use:

  cd server

After being in the folder, run the following command to start the project:

  yarn dev

💻 Techs

  • Autoprefixer
  • Axios
  • BiomeJs
  • Date fns
  • DayJs
  • Fastify
  • Fastify cors
  • Fastify Type Provider Zod
  • Javascript
  • Husky
  • Lint-staged
  • Localforage
  • Lucide React
  • Match sorter
  • Nodemailer
  • Postcss
  • Prisma
  • Prisma Client
  • React day picker
  • React Dom
  • React router dom
  • ReactJs
  • Sort by
  • TailwindCss
  • Tailwindcss Variants
  • Tsup
  • Tsx
  • Typescript
  • Vite
  • Vitejs Plugin React SWC
  • Zod

👤 Author

LeoMSSilva

🤝 Contributing

Contributions, issues and feature requests are welcome! Feel free to file a new issue on the plann.er repository. If you already found a solution to your problem, I would love to review your pull request!

📜 License

Copyright ©️ 2024 LeoMSSilva.
This project is MIT licensed.