React Hook Forms Demo Backend

A django project to build custom API and use with react hook forms to validate custom forms

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Requirements
   • Create a virtual environment
   • Installation
3. Usage
4. Contributing
5. Contact

About The Project

This project is an API demo built to make http requests and return custom responses to use them with the project React Hook Forms Demo

Built With

This project was build it with:

• Django
• Django rest framework

Getting Started

Requirements:

• Python version 3 (recommended 3.8 or less) in your path. It will install automatically pip as well.
• A virtual environment, namely .venv.

Create a virtual environment

Execute the next command at the root of the project:

python -m venv .venv

Activate the environment

Windows:

.venv\Scripts\activate.bat

In Unix based operative systems:

source .venv/bin/activate

Dependencies:

The dependencies are defined in requirements.txt.

Installation

Dependencies

Execute the next command once you have created the venv:

pip install -r requirements.txt

Usage

To start the server, you need locate in the next path:

 cd my_awesome_django_project

Before starting the server you need to add a secret key in settings.py, to generate a secret key you can run:

 ./manage.py djecrety

This library generates a secret key, you just need to copy the output and replace the text Insert your key here

Finally, you should run:

python manage.py runserve 

Contributing

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

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

Contact

Bryan Arellano - ridouku@gmail.com