Zoo django Actions

Sample Django App uilizing Github Actions and Docker for deployment and testing.

Accompanying Article

Read the accompanying article here

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• Python 3.7+

• Django 3.2.10

• Github Actions

• Postgresql Database.

  • This could either be installed locally or via docker. This article is an awesome resource on how to get Postgresql and pgadmin4 installed as containers.

    Create a database django_actions. Either using SQL or 3-party client like pgadmin4 or dbeaver

• Docker

• Docker Compose

(back to top)

Getting Started

To get started, you'll need to install the following:

Prerequisites

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

• Python 3.7

Installation

1. Clone the repo

   git clone https://github.com/KenMwaura1/zoo_Django_Actions.git

2. Create a virtual environment

   python -m venv venv

3. Activate the virtual environment

   source venv/bin/activate

4. Install the dependencies

   pip install -r requirements.txt

5. Add your credentials to a .env file

   echo "POSTGRESQL_HOST=localhost" >> .env
   echo "POSTGRESQL_PORT=5432" >> .env
   echo "POSTGRESQL_USER=postgres" >> .env
   echo "POSTGRESQL_PASSWORD=postgres" >> .env
   echo "POSTGRESQL_DB=zoo_Django_Actions" >> .env
   echo "POSTGRESQL_PORT=5432" >> .env

   OR Copy the provided example file to your .env file

   cp .env.example .env

6. Run the bot

   python manage.py runserver

   OR use the provided shell script

   ./run.sh

(back to top)

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

(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)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

@Ken_Mwaura1 - kemwaura@gmail.com

Project Link: https://github.com/KenMwaura1/zoo_Django_Actions

(back to top)