|
1 |
| -# Thinkify |
2 |
| -An Articles,Blogs,views writing App for the community. |
3 |
| -TechStack Used: Nodejs and MongoDB |
| 1 | +<h5 align ="center"> |
| 2 | + <H1 align ="center" > Thinkify </h1> |
| 3 | + An Articles,Blogs,views writing App for the community. |
| 4 | + TechStack Used: Nodejs and MongoDB |
| 5 | + Fullstack open source blogging application made with MongoDB, Express, React & Nodejs (MERN) </h5> |
| 6 | +<br/> |
| 7 | + |
| 8 | + * [Configuration and Setup](#configuration-and-setup) |
| 9 | + * [Technologies used](#technologies-used) |
| 10 | + - [Frontend](#frontend) |
| 11 | + - [Backend](#backend) |
| 12 | + - [Database](#database) |
| 13 | + |
| 14 | + |
| 15 | +## Configuration and Setup |
| 16 | + |
| 17 | +In order to run this project locally, simply fork and clone the repository or download as zip and unzip on your machine. |
| 18 | + |
| 19 | +- Open the project in your prefered code editor. |
| 20 | +- Go to terminal -> New terminal (If you are using VS code) |
| 21 | +- Split your terminal into two (run the Frontend on one terminal and the Backend on the other terminal) |
| 22 | + |
| 23 | +In the first terminal |
| 24 | + |
| 25 | +``` |
| 26 | +$ cd Frontend |
| 27 | +$ npm install (to install frontend-side dependencies) |
| 28 | +$ npm run start (to start the frontend) |
| 29 | +``` |
| 30 | +``` |
| 31 | +# --- Terminal --- |
| 32 | +
|
| 33 | +$ npm install (to install backend-side dependencies) |
| 34 | +$ npm start (to start the backend) |
| 35 | +``` |
| 36 | + |
| 37 | +## Key Features |
| 38 | + |
| 39 | +- User registration and login |
| 40 | +- Authentication using JWT Tokens |
| 41 | +- CRUD operations (Story create, read, update and delete) |
| 42 | +- Upload user ımages and Article related ımages to the server |
| 43 | +- Adding Articles to the Reading list |
| 44 | +- Responsive Design |
| 45 | + |
| 46 | +<br/> |
| 47 | + |
| 48 | +## Technologies used |
| 49 | + |
| 50 | +This project was created using the following technologies. |
| 51 | + |
| 52 | +#### Backend |
| 53 | + |
| 54 | +- [Node js](https://nodejs.org/en/) -A runtime environment to help build fast server applications using JS |
| 55 | +- [Express js](https://www.npmjs.com/package/express) -The server for handling and routing HTTP requests |
| 56 | +- [Mongoose](https://mongoosejs.com/) - For modeling and mapping MongoDB data to JavaScript |
| 57 | +- [express-async-handler](https://www.npmjs.com/package/express-async-handler) - Simple middleware for handling exceptions inside of async express routes and passing them to your express error handlers |
| 58 | +- [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken) - For authentication |
| 59 | +- [Bcryptjs](https://www.npmjs.com/package/bcryptjs) - For data encryption |
| 60 | +- [cors](https://www.npmjs.com/package/cors) - Provides a Connect/Express middleware |
| 61 | + |
| 62 | + |
| 63 | +#### Database |
| 64 | + |
| 65 | + - [MongoDB ](https://www.mongodb.com/) - It provides a free cloud service to store MongoDB collections. |
0 commit comments