trellixvulnteam / django_angular_todoapp_8ck0

Django_Angular_ToDoApp

Table of Contents

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

About The Project

This is a simple ToDo App developed using Django Rest Framework and Angular for backend and frontend respectively. It has feature of adding a todo and enlisting all todos in a list. SQLite database is used for all the todos.

(back to top)

Built With

Following libraries and Frameworks are used to Bootstrap this project.

• Django
• Angular
• SQLite
• Bootstrap

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Npm

  npm install npm@latest -g

• Python

  Download python from [Python](https://www.python.org/downloads/) and install it.

• Django

  pip install Django.

• Django Rest Framework

  pip install djangorestframework

Installation

1. Clone the repo

 git clone https://github.com/uxairibrar/Django_Angular_ToDoApp

2. Start Django Server

   python manage.py runserver

3. Start Angular Application

   ng server --open

4. If you need to test angular Django application

   ng test

5. If you need to test Django URLs, Views, Models

    python manage.py test todoapp

(back to top)

Usage

1. Press the todo button on the URL as /todo
2. Following modal will be appeared
3. Enter the todo's text in the text area and press the add button.
4. Record will be updated in SQLite database.
5. Close the modal and see the updated list.

(back to top)

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Your Name – [email protected].

Project Link: https://github.com/uxairibrar/Django_Angular_ToDoApp.

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

(back to top)