Sky-Guardian

An awesome Weather detection tool!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

This is a weather app as it name suggests. I started this project in order to test my command over python and overcome the challenges which come along the way while building this project from scratch.

I recently added a dockerfile to the project to increase the scalability of the application and will be using other DevOps based tools in the future.

Use the README.md to get started.

(back to top)

Built with

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• django

  pip install django

Installation

Follow the steps below to install the application

1. Clone the repo

   git clone https://github.com/AnishDubey27/Sky-Guardian.git

2. Go inside the newly created directory

   cd Sky-Guardian

3. Run the project locally

   python manage.py runserver

Alternatively, using docker:

1. Clone the repo

   git clone https://github.com/AnishDubey27/Sky-Guardian.git

2. Go inside the newly created directory

   cd Sky-Guardian

3. Run the project

   docker-compose up

(back to top)

Contributing

• Take a look at the existing Issues
• Fork the Repo create a branch for any issue that you are working on and commit your work.
• Create a ** Pull Request, which will be promptly reviewed and given suggestions for improvements by the community.
• Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes that are included in your commits.

How to make a Pull Request?

1. Start by forking the Sky-Guardian repository. Click on the symbol at the top right corner.

2. Clone your forked repository:

git clone https://github.com/<your-github-username>/Sky-Guardian.git

3. Navigate to the new project directory:

cd Sky-Guardian

4. Set upstream command:

git remote add upstream https://github.com/AnishDubey27/Sky-Guardian.git

5. Create a new branch:

git checkout -b YourBranchName

or

git branch YourBranchName
git switch YourBranchName

6. Sync your fork or local repository with the origin repository:

• In your forked repository click on "Fetch upstream"
• Click "Fetch and merge".

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream

git merge upstream/main

Github Docs for Syncing

7. Make your changes to the source code.

8. Stage your changes and commit:

⚠️ Make sure not to commit package.json or package-lock.json file

⚠️ Make sure not to run the commands git add . or git add *. Instead, stage your changes for each file/folder

git add file/folder

git commit -m "<your_commit_message>"

9. Push your local commits to the remote repository:

git push origin YourBranchName

10. Create a Pull Request!

11. Congratulations! You've made your first contribution! 🙌🏼

(back to top)

License

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

(back to top)

Contact

Anish Dubey - @Anish_Dubey_ - anishdubey100@gmail.com

Project Link: https://github.com/AnishDubey27/Sky-Guardian

(back to top)