Skip to content

kelvinmburu/mtaani

Repository files navigation

Mtaani

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.

Site Screenshot

Django Admin Login

To access the admin dashboard, follow the instructions below:

  • Navigate to https://mtaanih.herokuapp.com/admin
  • Username: sumtaa
  • Password: muut&830

Project Run-Through

  • A few details about this project:

GitHub Repo Size Lines of Code GitHub License GitHub Top Language GitHub Language Count GitHub Commit Activity

Contribution

Technology Used

  1. Python 3.8
  2. Django version 4
  3. HTML, CSS and JavaScript
  4. Pip
  5. Tailwind CSS Framework

Project Requirements & Prerequisites

  1. IDE of Choice
  2. Python3
  3. Browser of choice (Safari, Chrome, Mozilla, Edge)
  • Please ensure you're working from a Windows/MacOS/Linux
  • Install Django through pip install django

Project Setup and Installation

  1. Proceed to this link and clone the repository.
  2. Extract the folder and cd to the folder on your terminal or your prefered IDE
  3. In the terminal, create a virtual environment: python3 -m venv virtual and activate it through source virtual/bin/activate. In the case of any name, please use source <name>/bin/activate or refer to this documentation for Flask virtual environment installation.
  4. Install all dependencies from the requirements.txt file; use pip install -r requirements.txt to install needed dependencies.
  5. In the terminal, and within the project folder, run python manage.py runserver to start the project.
  6. View the application on your browser on http://127.0.0.1:8000. If you have another project running on another port, use venv run --host 0.0.0.0 --port 8001 to switch to a new port; You can use a different port number.
  7. Ensure to open another terminal for running Tailwind; this allows it to display the needed templates. To run Tailwind server, use python manage.py tailwind start

Behavior Driven Development (BDD)

The BDD focuses on how a user interacts with the application.

At a minimum, this is what the user should experience in the application:

Project Contribution or Development:

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

Known Issues & bugs

To improve this project or fix a bug, please reach me via Email:

Alternatively, you can contact me via LinkedIn

License

Please view the project LICENSE for more information.

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors