Overview
The project is a clean monorepo with a Flask/Python backend API and a React/Typescript frontend. It serves as a library of user-created code snippets with features for organizing, searching, and interacting with snippets. The project aims to provide a platform for users to create and manage their own code snippets and collections.
Features
- User Registration: New visitors can register for an account.
- User Login: Returning visitors can securely log in to their account.
- Create Code Snippet: Returning visitors can create their own code snippets.
- View Code Snippet: Returning visitors can view their code snippets.
- Edit Code Snippet: Returning visitors can edit their code snippets.
- Delete Code Snippet: Returning visitors can delete their code snippets.
- Create Collection: Returning visitors can create collections of code snippets.
- View Collection: Returning visitors can view their collections of code snippets.
- Edit Collection: Returning visitors can edit their collections of code snippets.
- Delete Collection: Returning visitors can delete collections of their code snippets.
- Search Code Snippets: Frequent visitors can search for code snippets they have created.
- Search Others’ Code Snippets: Frequent visitors can search for code snippets created by others.
- Favorite Code Snippets: Frequent visitors can like/fave code snippets created by others.
- View Favorite Code Snippets: Frequent visitors can view their favorite code snippets created by others.
- Unfavorite Code Snippets: Frequent visitors can unlike/unfave code snippets they have previously liked.
- Copy Code Snippets: Frequent visitors can copy code snippets to the clipboard.
- Delete Account: Frequent visitors can delete their account.
Installation
To install the project, follow these steps:
- Clone this repository.
- Install the necessary dependencies by running the following commands:
npm install
pip install requirements.txt
- Set up the backend by configuring the Flask/Python backend API and connecting to a MongoDB Atlas database.
- Set up the frontend by configuring the React/Typescript CRA frontend.
- Run the project using the following command:
npm start
Summary
The project is a monorepo with a Flask/Python backend API and a React/Typescript frontend. It provides a platform for users to create, manage, and search code snippets and collections. The project includes features for user registration, login, code snippet creation, editing, and deletion, collection creation, editing, and deletion, code snippet searching, favoriting, and copying, and account deletion.