A web application that allows users to be in the loop about everything happening in their neighborhoods. From contact information of different handyman to meeting announcements or even alerts.
To access the admin dashboard, follow the instructions below:
- Navigate to
https://mtaanih.herokuapp.com/admin - Username:
sumtaa - Password:
muut&830
- A few details about this project:
- Python 3.8
- Django version 4
- HTML, CSS and JavaScript
- Pip
- Tailwind CSS Framework
- IDE of Choice
- Python3
- Browser of choice (Safari, Chrome, Mozilla, Edge)
- Please ensure you're working from a Windows/MacOS/Linux
- Install Django through
pip install django
- Proceed to this link and clone the repository.
- Extract the folder and
cdto the folder on your terminal or your prefered IDE - In the terminal, create a virtual environment:
python3 -m venv virtualand activate it throughsource virtual/bin/activate. In the case of any name, please usesource <name>/bin/activateor refer to this documentation for Flask virtual environment installation. - Install all dependencies from the
requirements.txtfile; usepip install -r requirements.txtto install needed dependencies. - In the terminal, and within the project folder, run
python manage.py runserverto start the project. - View the application on your browser on
http://127.0.0.1:8000. If you have another project running on another port, usevenv run --host 0.0.0.0 --port 8001to switch to a new port; You can use a different port number. - Ensure to open another terminal for running
Tailwind; this allows it to display the needed templates. To run Tailwind server, usepython manage.py tailwind start
The BDD focuses on how a user interacts with the application.
At a minimum, this is what the user should experience in the application:
To contribute to this project, please follow the following steps:
- Fork the repository.
- Create a branch:
git checkout -b <branch_name>. - Make your changes and commit them:
git add .&&git commit -m '<commit_message>'&&git push origin <branch_name> - Push to the original branch:
git push origin <branch_name> - Create the pull request.
- Once a PR is reviewed, the changes will be pushed to the main branch for integration.
Please see the GitHub documentation on Creating a Pull Request
To improve this project or fix a bug, please reach me via Email:
Alternatively, you can contact me via LinkedIn
Please view the project LICENSE for more information.
