Table of Contents

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

About The Project

In this project, I aim to perform operations such as testing and managing CRUD operations by making use of the documentation of the relevant libraries in terms of contributing to the logic operations on the front-end side and understanding the operation, as well as understanding the way of managing the developments and functionality on the backend side with the trainings I have received.

Screenshots of Project

1. Home Page

Built With

In this section, the technologies used in the construction of the project are included.

Client-side

• React -> for Front-end
• React Hooks -> for Hooks
• React Router -> for Router
• Axios -> for HTTP Client requests
• Ant Design -> for Design
• CkEditor -> for Rich Text Editor

Server-side

• Cors -> for Cross-Origin Resource Sharing
• Dotenv -> for Environment Variables
• Nodemoon -> for Node Monitor
• Uuid -> for Unique Identifier
• Express -> for Web Framework
• Multer -> for File Upload
• Mysql -> for Database
• Swagger -> for Documentation
• Json Web Token -> for Authentication
• JWT -> for Authentication
• Jwt-decode -> for Authentication

Getting Started

In this section, the steps for the cloning of the project and the improvements to be made by you are shown.

Prerequisites

By following the steps below, your project can be run after the local installation.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/serifcolakel/CRUD-with-Mysql-NodeJS-ReactJS

2. Install NPM packages

   cd client
   npm install
   cd ..
   cd server
   npm install

3. Enter your SECRET_KEY in .env

   cd server
   SECRET_KEY="ENTER YOUR secret KEY"

4. Run the server with nodemon

   cd server
   npm run start

5. Run the client

   cd client
   npm run start

Usage

In this section, you can access the documentation of the libraries used during the creation of the project.

For more examples, please refer to the React Documentation React Hooks Documentation React Router Documentation Axios Documentation Ant Design Documentation CkEditor Documentation Cors Documentation Dotenv Documentation Nodemoon Documentation Uuid Documentation Express Documentation Multer DocumentationMysql DocumentationSwagger Documentation Json Web Token Documentation JWT Documentation Jwt-decode Documentation .

Roadmap

• Added Mysql Database Connection
• Added Login page design (with username/email verification)
• Added Router for the client
• Added Router for the server
• Added Blogs Crud page design (with CRUD operations)
• Added Users Crud page design (with CRUD operations)
• Improve server & client side file & folder structure
• Added CRUD functionality
• Improve CRUD functionality
• Add
• Added authentication
• Improve authentication functionality
• Add Redux
• Improve design
• Add user notifications

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Contact

Project Link: https://github.com/serifcolakel/todo-App