🗒📌 Pi'Notes

Front end part of the peanut note.

Stack used	Utility
React	Librarie (framework 🙄)
Typescript
TailwindCSS	Framework CSS
Redux	Centralized state
Toastify	Notification inside App

ViteJS ⚡️ : lightning-fast frontend build tool
ESLint / Prettier for beautiful code 🥰

How to clone/use the project :

git clone https://github.com/SaumonDelicieux/pi-notes.git
cd pi-notes
yarn i
yarn dev

⚠️ Don't forget to set .env.local (copy/paste/edit .env.example)

Workflow (Git) :

feature/XXXXXX : pour un feature
hotfix|fix/XXXXX : pour corriger un bug
Release/X.X.X : pour staging vers master (prod)

Utils

• Github (Github CI)
• Vercel (CD)
• NoSQL (MongoDB Atlas)
• Trello
• 🌍 Production
• 🌍 Staging
• 🌍 Develop

Features

• Pipeline CI/CD (Github CI & Vercel)
• Swagger API-Pi'Notes
• Authentication (login/register/reset password/confirm password)
• Profile page (update information)
• Create folder, sub-folder and assign note
• Download note as PDF
• Got Preview link (read only)
• Checkout with Stripe (Be Premium) and can cancel sub
• Search on all notes
• Update state of note (junk/public/achived, delete)
• WYSIWYG
• Auto-save
• Share note if Premium

To do

• Preview note
• User shared permission

🎨 Prototype

Click me 👋

🌳 Project structure

├── __tests__
├── .github                          # Github CI
├── src
│   ├── actions           # Redux
│   │   └── ...
│   ├── assets
│   │   ├── css
│   │   │   └── ...
│   │   ├── fonts
│   │   │   └── ...
│   │   └── images
│   │       └── ...
│   ├── components
│   │   └──  ...
│   ├── features          # Redux
│   │   └──  ...
│   ├── layouts
│   │   └──  ...
│   ├── pages
│   │   └──  ...
│   ├── routes
│   │   └──  ...
│   ├── types
│   │   └──  ...
│   └── helpers
│   │   └──  ...
│   ├── index.tsx
│   ├── App.tsx
│   └── store.tsx         # Redux
├── package.json
├── .env.example
├── .eslintrc.cjs
├── .prettierrc.cjs
├── postcss.config.js
├── LICENSE
├── vite.config.js
├── tailwind.config.js
├── tsconfig.json
└── yarn.lock

👯‍♂️ Collaborators

Groupe 2

• Enzo CANDOTTI @ecandotti
• Lamine ADEL @A-Lamine
• Walid MOKHTARI @walidmokhtari
• Melly LUCAS @mellylu
• Swann JUMPERTZ @RazAallgull60
• Nels27 @Nels27

⭐️ Show your support

Please give a ⭐ if this project helped you !

🪪 License

ISC © Saumon Délicieux