Gladys

Gladys is a chatbot built using Django. It is used to suggest the user various restaurants based on their cuisine choice or location.

Development Workflow

Setup your database in MySQL (Linux Only)

1. Install MySQL in your machine if you haven't and switch to MySQL Administrative User to perform administrative tasks.

   mysql -u root
   

2. Create Database Gladys for the project.

   CREATE DATABASE Gladys;
   

3. Select the created database.

   USE Gladys;
   

4. You can see all tables here once you have applied all the migrations which are discussed later.

5. Exit out of MySQL shell session.

   exit;
   

If you have any problems, go through this video. Similar procedure can be used for Windows and macOS.

Setup your development environment

1. Fork this repository.

2. Install virtual environment if you haven't and create a virtual environment on your machine.

   virtualenv -p python3 env
   

3. Activate the newly created virtual environment.

   cd env
   source bin/activate
   

4. Clone this repository (this would make rebasing easier).

   git clone https://github.com/deepaktiwari88/Gladys.git
   

5. Install the dependencies for the project.

   cd Gladys
   pip3 install -r requirements.txt
   

6. Run the migrations and collect static files.

   python3 manage.py migrate
   python3 manage.py collectstatic
   

7. Run the live development server on your machine and test it.

   python3 manage.py runserver
   

   Once the server is started, open http://127.0.0.1:8000 in a web browser. Everything went well if the webpage loads correctly and you don't see any errors.

8. Add a remote to your forked repository. This remote will be needed to push your changes to your repo.

   git remote add myfork https://github.com/<username>/Gladys.git