Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kenmwaura1/zoo_django_actions
Sample Django Web App for GitHub Actions
https://github.com/kenmwaura1/zoo_django_actions
django github-actions python
Last synced: 2 months ago
JSON representation
Sample Django Web App for GitHub Actions
- Host: GitHub
- URL: https://github.com/kenmwaura1/zoo_django_actions
- Owner: KenMwaura1
- License: mit
- Created: 2021-12-08T21:36:16.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T09:05:27.000Z (4 months ago)
- Last Synced: 2024-10-28T11:38:59.429Z (4 months ago)
- Topics: django, github-actions, python
- Language: Python
- Homepage:
- Size: 87.9 KB
- Stars: 8
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/KenMwaura1/zoo_Django_Actions/actions/workflows/zoo_django_actions.yml)
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
<<<<<<< Updated upstream
=======
>>>>>>> Stashed changes
Zoo django Actions
Sample Django App uilizing Github Actions and Docker for deployment and testing.
## Accompanying Article
Read the accompanying article [here](https://dev.to/ken_mwaura1/beginners-guide-to-github-actions-django-and-docker-2om6)
Table of Contents
## About The Project
### Built With
* [Python 3.7+](https://www.python.org/downloads/)
* [Django 3.2.10](https://www.djangoproject.com/download/)
* [Github Actions](https://docs.github.com/en/actions)
* Postgresql Database.
* This could either be installed [locally](https://www.postgresql.org/) or via [docker](https://www.docker.com/).
This [article](https://blog.crunchydata.com/blog/easy-postgresql-12-and-pgadmin-4-setup-with-docker) 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](https://dbeaver.io/)
* [Docker](https://www.docker.com/)
* [Docker Compose](https://docs.docker.com/compose/install/)
## 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](https://www.python.org/downloads/)
### Installation
1. Clone the repo
```sh
git clone https://github.com/KenMwaura1/zoo_Django_Actions.git
```
2. Create a virtual environment
```sh
python -m venv venv
```
3. Activate the virtual environment
```sh
source venv/bin/activate
```
4. Install the dependencies
```sh
pip install -r requirements.txt
```
5. Add your credentials to a .env file
```sh
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
```sh
cp .env.example .env
```
6. Run the bot
```sh
python manage.py runserver
```
OR use the provided shell script
```sh
./run.sh
```
See the [open issues](https://github.com/KenMwaura1/zoo_Django_Actions/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!
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
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
[@Ken_Mwaura1](https://twitter.com/Ken_Mwaura1) - [email protected]
Project Link: [https://github.com/KenMwaura1/zoo_Django_Actions](https://github.com/KenMwaura1/zoo_Django_Actions)
[contributors-shield]: https://img.shields.io/github/contributors/KenMwaura1/zoo_Django_Actions.svg?style=for-the-badge
[contributors-url]: https://github.com/KenMwaura1/zoo_Django_Actions/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/KenMwaura1/zoo_Django_Actions.svg?style=for-the-badge
[forks-url]: https://github.com/KenMwaura1/zoo_Django_Actions/network/members
[stars-shield]: https://img.shields.io/github/stars/KenMwaura1/zoo_Django_Actions.svg?style=for-the-badge
[stars-url]: https://github.com/KenMwaura1/zoo_Django_Actions/stargazers
[issues-shield]: https://img.shields.io/github/issues/KenMwaura1/zoo_Django_Actions.svg?style=for-the-badge
[issues-url]: https://github.com/KenMwaura1/zoo_Django_Actions/issues
[license-shield]: https://img.shields.io/github/license/KenMwaura1/zoo_Django_Actions.svg?style=for-the-badge
[license-url]: https://github.com/KenMwaura1/zoo_Django_Actions/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/kennedy-mwaura/