Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vertocode/mycruds
MyCruds allow users create custom CRUDs on any topic. Manage lists effortlessly by adding, editing, and deleting items as needed.
https://github.com/vertocode/mycruds
crud mongodb nextjs nodejs reactjs tailwindcss typescript
Last synced: 7 days ago
JSON representation
MyCruds allow users create custom CRUDs on any topic. Manage lists effortlessly by adding, editing, and deleting items as needed.
- Host: GitHub
- URL: https://github.com/vertocode/mycruds
- Owner: vertocode
- Created: 2024-07-06T23:37:46.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-13T20:52:47.000Z (5 months ago)
- Last Synced: 2024-08-24T02:53:30.507Z (4 months ago)
- Topics: crud, mongodb, nextjs, nodejs, reactjs, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://mycruds.vertocode.com
- Size: 664 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Demo
## Principal Links
- [Deployed App 🚀](https://mycruds.vertocode.com)
- [Video Demo ▶️](https://www.youtube.com/watch?v=xNJql5M38N8)
## Introduction
MyCruds allow users create custom CRUDs on any topic. Manage lists effortlessly by adding, editing, and deleting items as needed.
After creating a CRUD, users can access a custom list according to the field filled during the CRUD creation, and can search for items about the topic created, create new items, edit, and delete when needed. In addition, after creating a crud the edition of it is available on anytime.
## Features
- Sign up
- Sign in
- Create a CRUD
- Edit a CRUD
- Delete a CRUD
- List all CRUDs
- List all CRUD items
- Create a CRUD item
- Edit a CRUD item
- Delete a CRUD item
- Search for a CRUD item
- Logout
## Technologies
- [React](https://reactjs.org/)
- [Next.js](https://nextjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [React Hook Form](https://react-hook-form.com/)
- [Redux](https://redux.js.org/)
- [Yup](https://www.npmjs.com/package/yup)
- [SWR](https://swr.vercel.app/)
- [Tailwind](https://tailwindcss.com/)
- [ESLint](https://eslint.org/)
- [MUI](https://mui.com/)
## Installation
1. Clone the repository
```bash
git clone [email protected]:vertocode/mycruds.git
```
2. Install the dependencies
```bash
npm run i
```
3. Set the environment variables
```bash
cp .env.sample .env
```
4. Run the application
```bash
npm run dev
```
## Folder Structure
| Folder | Description |
|--------------------------|---------------------------------------------------------------|
| /public | The public folder, where the logo, and images are located. |
| src/api | The request functions that is made to get data from API. |
| src/app | The main application folder, where the pages are located. |
| src/assets | The application assets. |
| src/components | The components used in the application. |
| src/hooks | The application React custom hooks. |
| src/internationalization | Folder with the dictionary in portuguese and english texts. |
| src/services | The application services, where we have the API calls. |
| src/store | The redux folder to store whole data like crud and user data. |
| src/types | The application types to use with TypeScript. |
| src/utils | The application utils where we have the common functions. |
# How to run lint
```bash
npm run lint
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.