SoulMate using React CS-555-Agile Development Project

Introduction

• 
• This a Project primaryly focus on solar project management system that we prepared for CS-555-Agile Development Project using React, Firebase.
• Team: Easy Scurm
• Team Members: Rongda Kang,Kevin Dsa, Yuzhi Wang(Scrum Master),Luoyi Fu, Mingze Sun.

📒 Index

• About
• Usage
  • Installation
  • Commands
• Development
  • Pre-Requisites
  • Developmen Environment
  • File Structure
  • Build
  • Deployment
• Community
  • Contribution
  • Branches
  • Guideline
• FAQ
• Resources
• Gallery
• Credit/Acknowledgment
• License

🔰 About

To use the Project, I recommand you using standard NPM, If you have package manger yarn, just follow the common instructions

⚡ Usage

Write about how to use this project.

🔌 Installation

• Steps on how to install this project, to use it.
• Be very detailed here, For example, if you have tools which run on different operating systems, write installation steps for all of them.

$ npm install

📦 Commands

$ npm start

🔧 Development

If you want to contribute to this project, please send us a email through [email protected]

📓 Pre-Requisites

List all the pre-requisites the system needs to develop this project.

• A An editor
• B NPM Modules

🔩 Development Environment

Here are some simple steps

• How to download the project clone to your local repository
• How to install dependencies : everything came in in package.json

📁 File Structure

Add a file structure here with the basic details about files, below is an example.

.
├── public
│   ├── favicon.ico
│   ├── index.html
│   ├── logo192.png
│   ├── logo512.png
│   ├── manifest.json
│   └── robots.txt
├── src
│   ├── components
│   │   ├── footer
│   │   │   ├── Footer.css
│   │   │   └── Footer.js
│   │   ├── header
│   │   │   ├── Header.css
│   │   │   └── Header.js
│   │   ├── layout
│   │   │   ├── Layout.css
│   │   │   └── Layout.js
│   │   ├── pages
│   │   │   ├── About.js
│   │   │   ├── Home.js
│   │   │   └── NotFound.js
│   │   ├── AppRouter.js
│   │   ├── GeneratePDF.js
│   │   └── UserTable.js
│   ├── services
│   │   └── dataService.js
│   ├── App.css
│   ├── App.js
│   ├── App.test.js
│   ├── index.css
│   ├── index.js
│   ├── logo.svg
│   ├── reportWebVitals.js
│   └── setupTests.js
├── .gitignore
├── package-lock.json
├── package.json
└── README.md

🔨 Build

Follow standard React Project Build Intructions

🚀 Deployment

Follow Standard Web Application build Instructions

🌸 Community

If it's open-source, talk about the community here, ask social media links and other links.

🔥 Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project. Your name will be listed here:

1. Report a bug
   If you think you have encountered a bug, and I should know about it, feel free to report it to email on this page and I will take care of it.

2. Request a feature
   You can also request for a feature here, and if it will viable, it will be picked for development.

3. Create a pull request
   It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.

If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.

🌵 Branches

I use an agile continuous integration methodology, so the version is frequently updated and development is really fast.

1. stage is the development branch.

2. master is the production branch.

3. No other permanent branches should be created in the main repository, you can create feature branches but they should get merged with the master.

Steps to work with feature branch

1. To start working on a new feature, create a new branch prefixed with feat and followed by feature name. (ie. feat-FEATURE-NAME)
2. Once you are done with your changes, you can raise PR.

Steps to create a pull request

1. Make a PR to stage branch.
2. Comply with the best practices and guidelines e.g. where the PR concerns visual elements it should have an image showing the effect.
3. It must pass all continuous integration checks and get positive reviews.

After this, changes will be merged.

❗ Guideline

Please follow the coding standard practice and formulate your code clear and readable as well as maintanable

❓ FAQ

If you have questions please email [email protected] for additional info and help

📄 Resources

Add important resources here

📷 Gallery

Pictures of your project.

🌟 Credit/Acknowledgment

Rongda Kang, Kevin Dsa, Yuzhi Wang, Luoyi Fu, Mingze Xu, Additional Creadit to React, Tailwindcss,