Skip to content

Commit

Permalink
docs(to-do-app): add project readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yntpdotme committed Mar 4, 2024
1 parent 7a603cc commit be4d4a9
Show file tree
Hide file tree
Showing 3 changed files with 101 additions and 1 deletion.
25 changes: 24 additions & 1 deletion 0-1/projects/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
# Projects 0-1
<a href="./">
<h1 align="center">Project Genesis</h1>
</a>

<p align="center">
Showcase of my journey to building a solid Foundation.
</p>

<div align= "center">

[![Twitter Badge](https://img.shields.io/badge/-@KadlagAkash-1ca0f1?style=flat&labelColor=1ca0f1&logo=twitter&logoColor=white&link=https://twitter.com/KadlagAkash)](https://twitter.com/KadlagAkash) &nbsp; [![Linkedin Badge](https://img.shields.io/badge/-KadlagAkash-0e76a8?style=flat&labelColor=0e76a8&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kadlagakash/) &nbsp; [![Mail Badge](https://img.shields.io/badge/-akashkadlag14-c0392b?style=flat&labelColor=c0392b&logo=gmail&logoColor=white)](mailto:akashkadlag14@gmail.com) &nbsp; [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)&nbsp; [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)

</div>
<br>

- ### [Week 5 : Basic To Do App (MERN)](./basic-to-do-app/README.md)
</br></br>

## Contributing

Contributions are always welcome!

See [CONTRIBUTING.md](../../CONTRIBUTING.md) for ways to get started.
</br></br>
77 changes: 77 additions & 0 deletions 0-1/projects/basic-to-do-app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<h1 align="center">Basic To Do App</h1>

<p align="center">
"A MERN project for practicing the tech-stack."
</p>

<p align=center>
<img width = "700px" alt="Jio Network blocking the view? Network switch reveals the magic!" src="./assets/mern.png">
<p>

<div align= "center">

[![Twitter Badge](https://img.shields.io/badge/-@KadlagAkash-1ca0f1?style=flat&labelColor=1ca0f1&logo=twitter&logoColor=white&link=https://twitter.com/KadlagAkash)](https://twitter.com/KadlagAkash) &nbsp; [![Linkedin Badge](https://img.shields.io/badge/-KadlagAkash-0e76a8?style=flat&labelColor=0e76a8&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kadlagakash/) &nbsp; [![Mail Badge](https://img.shields.io/badge/-akashkadlag14-c0392b?style=flat&labelColor=c0392b&logo=gmail&logoColor=white)](mailto:akashkadlag14@gmail.com) &nbsp; [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)&nbsp; [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)

</div>

<h2 align="center">

[🗂️&nbsp; Frontend](./client/)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Backend &nbsp;📂](./server/)

</h2>
<br>

<p align="center">
<a href="#introduction"><strong>Introduction</strong></a>
·&nbsp;<a href="#features"><strong>Features</strong></a>
·&nbsp;<a href="#tech-stack"><strong>Tech Stack</strong></a>
·&nbsp;<a href="#local-development"><strong>Development Setup</strong></a>
</p>
<br>

## <a name="introduction">❄️&nbsp; Introduction</a>

To-Do App created during Week-5 of 100xDevs Cohort by Harkirat Singh.

<p align=center>
<img width = "700px" alt="Jio Network blocking the view? Network switch reveals the magic!" src="./assets/frontend.png">
<p>
<br>

## <a name="features">🔋&nbsp; Features</a>

- **Organized File and Folder Structure**: Maintain a well-organized file and folder structure for easy navigation and management of project assets.

- <br><br>

## <a name="tech-stack">⚙️&nbsp; Tech Stack</a>

- [MongoDB](https://www.mongodb.com/) – NoSQL database
- [Express](https://expressjs.com/) – Web application framework
- [React](https://react.dev/) – library for building UI
- [Node.js](https://nodejs.org/) – JavaScript runtime
- [Mongoose](https://mongoosejs.com/) – MongoDB object modeling
- [RESTful API](https://restfulapi.net/) – API design principles
- [Git](https://git-scm.com/) – versioning
- [Vite](https://vitejs.dev/) – building
<br><br>

## <a name="local-development"> 🖥️&nbsp;&nbsp; Local Development</a>

1. **Clone the repository:**

```bash
git clone https://github.com/KadlagAkash/100xdevs-full-stack-mastery.git
```

2. **Navigate to the project directory:**

```bash
cd 100xdevs-full-stack-mastery/0-1/projects/basic-to-do-app/
```

<br><br>

## 🪪&nbsp;&nbsp; Licensing Information

- It is licensed under the [MIT License](./LICENSE). Feel free to learn, add upon, and share!
Binary file added 0-1/projects/basic-to-do-app/assets/mern.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit be4d4a9

Please sign in to comment.