Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/serifcolakel/todo-app

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/serifcolakel/todo-app
Owner: serifcolakel
Created: 2022-02-06T18:47:59.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-02-07T19:01:09.000Z (almost 3 years ago)
Last Synced: 2024-11-09T02:52:35.543Z (2 months ago)
Language: JavaScript
Homepage: todo-serifcolakel.vercel.app
Size: 86.9 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

Table of Contents

About The Project
- Built With

Getting Started
- Prerequisites
- Installation

Usage

Roadmap

Contributing

Contact

## About The Project

In this project, I developed the TODO application, which is one of the projects for developers at the introductory stage, by applying the design examples I obtained from the internet. Apart from the good experience I had, it offered the opportunity to apply the back-end methods I learned.

Image of Project

Home Page

Home Page Responsive

Todo Page Responsive

### Built With

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

- [Next.js](https://nextjs.org/)
- [SASS](https://sass-lang.com/)
- [MongoDB](https://www.mongodb.com/)
- [Heroku](https://www.heroku.com/home)
- [Vercel](https://vercel.com/)

## 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
```sh
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
```sh
git clone https://github.com/serifcolakel/todo-App.git
```
2. Install NPM packages
```sh
npm install
```
3. Enter your API in `.env`
```.env
NEXT_PUBLIC_API_URL="ENTER YOUR API"
```
4. Run the app
```sh
npm run dev
```

## 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 [MongoDB Documentation](https://docs.mongodb.com/), [Next.js Documentation](https://nextjs.org/), [SASS Documentation](https://sass-lang.com/documentation)._

## Roadmap

- [x] Added authentication
- [x] Added Home page design (with username/email verification)
- [x] Added Register page design (with username/email verification)
- [x] Added Login page design (with username/email verification)
- [x] Added todo list management
- [ ] Add user profile
- [ ] Add user settings
- [ ] Add user notifications

See the [open issues](https://github.com/serifcolakel/todo-App/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](https://github.com/serifcolakel/todo-App)