Sam's Personal Library

A storage for quick acess to my code snippets

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact

About The Project

Here and there in the course of a project I remember that somewhere in the middle of my codes exists a snippet that fit exaclty what I need.So I made this little project to not waste much time searching for, and also to enhance my knowledge of Server Actions on Next 14 and NEXTAUTH.

(back to top)

Built With

• Next.JS
• CockroachDB
• Monaco Editor

• Prisma

• NextUI
• TailwindCSS

• Framer-Motion

• NextAuth.js

(back to top)

Getting Started

You can update this project to your own version

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/samuelcolares/dailyTodo.git

2. Install NPM packages

   npm install

3. Change DB provider on Prisma.Schema file

   datasource db {
     provider = "cockroachdb" // <-- your choice, could it be mysql, postgre, mongoDB, sqlite...
     url      = env("DATABASE_URL")
    }

4. Chance variables on your .env file

   //create a .env file
   NEXTAUTH_URL = "YOURPROJECTURL";
   NEXTAUTH_SECRET = "YOURNEXTAUTHSECRET";
   
   DATABASE_URL = "YOURDATABASEURL";

5. Start local with

   npm run dev

This is an example of how to install locally using NPM, but of course you can use, PNPM, YARN, BUN.

(back to top)

Usage

1. Login Page

2. Home Page

Filter by snippet title name, snippet code and category

Also, Show/Hidden Columns selector and display a total of 5, 10 or 15 snippets per page

3. Snippets

3.1 New Snippet

3.2 View Snippet

3.3 Edit Snippet

4. Categories Page

Filter by category title name

5. Categories

5.1 New Category

5.2 Edit Category

6 Delete Modal

(back to top)

Roadmap

• [ X ] Store management (CRUD) using Next14 Server Actions with DB(CockroachDB)
• [ X ] Creating Tables with NextUI (that i shall never use again)
• [ X ] Fetching data to tables
• [ X ] NextAuthJS

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Samuel Colares - LinkedIn - [email protected]

(back to top)