https://github.com/defcon-007/bunnyshell-environment

https://github.com/defcon-007/bunnyshell-environment

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/defcon-007/bunnyshell-environment
• Owner: DefCon-007
• Created: 2023-07-05T18:25:11.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-07-10T14:11:33.000Z (over 1 year ago)
• Last Synced: 2024-11-08T05:36:29.242Z (2 months ago)
• Language: JavaScript
• Size: 37.5 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## 🌟 Contribute to Bunnyshell Environment Template

Welcome to the Bunnyshell Environment Template for FastAPI + React + PostgreSQL! 🎉

This template provides a streamlined starting point for developers looking to kickstart their projects with the FastAPI, React, and PostgreSQL stack. It offers a simple and intuitive todo application, allowing you to effortlessly add and delete todos with just a click of a button.

With FastAPI's auto-documenting playground, you'll have a seamless experience exploring and interacting with the APIs from the get-go. Plus, the frontend is enhanced with Creative Tim's Material 2 React Pro template, giving your app a stunning and modern look.

# Demo

Sample application is available at following endpoints:

- Backend: https://backend-2ilgpt.bunnyenv.com/

- Frontend: https://frontend-2ilgpt.bunnyenv.com/todo

![frontend-demo](https://github.com/bunnyshell/templates/assets/16754547/5a40a8f4-237c-4a67-bda1-6b0f8e8422aa)

### Backend API demo

![backend-documnetation](https://github.com/bunnyshell/templates/assets/16754547/44061906-1b23-4c3b-ad06-678a14c77432)

### Backend Documentation

![image](https://github.com/bunnyshell/templates/assets/16754547/f740016f-b5e1-4804-9ed0-86aa032fdbf5)

### Contribute

We invite you to contribute and make this template even better! Follow the steps below to submit your valuable pull request.

1. 🍴 Fork the Repository

   Start by forking this repository to your GitHub account. This will create a personal copy of the project under your account, enabling you to make changes freely.

2. 🌿 Create a New Branch

   Next, create a new branch in your forked repository. Choose a descriptive and meaningful name for your branch, reflecting the nature of the changes you intend to make.

3. ✍️ Make Your Changes

   Now it's time to unleash your creativity! Make the desired changes to the Bunnyshell Environment Template. You can improve the documentation, fix any bugs, or even add exciting new features. Remember to maintain clean code, provide helpful comments, and adhere to the project's coding style.

4. 🚀 Commit and Push

   Once you are satisfied with your changes, commit them to your branch and push them to your forked repository. Craft clear and concise commit messages that explain the purpose and impact of your changes.

5. 💌 Submit a Pull Request

   The grand finale! Open a pull request from your branch to the original repository. Share a detailed description of your changes, including any relevant information that will help reviewers understand and appreciate your contribution.

🎉 Congratulations!

You've taken the first step towards improving the Bunnyshell Environment Template. Your efforts and ideas are greatly appreciated. Let's build something amazing together!