CodeNote 📘📕

Getting Started - Contributing

What is CodeNote? 🤔

CodeNote it's a fullstack todo list app, focused on enhancing the process of managing tasks. When we have a task we generally use and research for a lot of documentation, in the form of url's to websites, videos, etc. The goal of this project it's to take all the information we may need to complete our taks, and organize them in one place

Web Stack 💻

• Astro 🟠
• React
• Typescript 🟦
• Tailwind CSS ☁️
• Supabase 🟢 for user management
• MongoDB 🥬 for storing data

Note that since the framework is Astro, you can contribute using any other framework you want

Libraries

• date-fns 📆
• FontAwesomeIcons 🖼️
• React Query ⚛️
• Million ⚡
• Mongoose 🍏

🚀 Getting Started

1. Fork or clone this repo

git clone [email protected]:DeikuModder/code-note.git

2. Install the dependencies

npm install

3. Run development server

npm run dev

4. Open http://localhost:4321 with your browser!

Contributing 💜

First you need to check the .env.EXAMPLE file to check what are the enviroment variables you need to get the project going, there you'll find the public credentials you need for Supabase, and an example on MongoDB credentials.

Create a MongoDB account

In order to test the project with a db, you'll need to create one yourself, this is very easy and fast, i'll leave you a link on getting started on MongoDB, as well as a free course form Studio3T

• https://www.mongodb.com/docs/manual/tutorial/getting-started/
• https://studio3t.com/academy/courses/mongodb-101-getting-started/

In case you'd like to contribute directly with the official db of the project you'll need to contact me.

In order to test with the AI, you'll need to create an account on Cohere, and generate your API Key

• https://docs.cohere.com/

At the time of contributing keep in mind the following:

1. Don't mess with the folder structure 📁
2. If you're going to add images, please remember to optimize them and for them to be in .WEBP format 🖼️

I'll leave you a list of things you can contribute on if you want:

• A dark mode for the page, there's already a hook for using the local storage, you can use that! 🌙
• Animations for the toasts 🍞
• Show a notification toast when a note it's reaching it's deadline, but only one time 📆

And obviously if you find a bug and you want to fix it, do it with no doubt!