trcclub / community_app_boilerplate

This is an open source project for creating a Flutter app that shall serve as a template/boilerplate for various technical communities, clubs, organizations, etc to use.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Community App Boilerplate

Forks Stars Issues Pull Requests License Gitter

This is an open source project for creating a Flutter app that shall serve as a template/boilerplate for various technical communities, clubs, organizations, etc to use.

With certain modifications to the content specific to the communinity or group using this, the need to build an app from scratch and the pains of fixing bugs and figuring out what part fits where is eliminated. Feel free to use this!. If this project helps out, we would be grateful, if you could give us a mention. Also, we would love to see your version of the same! Do a give a PR for a different branch that showcases how you used this!

This project is also meant to be a starting for all techies interested to get their hands dirty in open-source contributions. A highlight of this project being this project is "built by the community for the community". This takes off from the similar effort by the project admin for GirlScript Summer of Code in the following projects:

Currently this is a part of Rails Girls Summer of Code'2020RGSOC'20

A follow up project:

πŸ“· A sneak peek at the current UI of the app:

Sneak

Sign In Page Sign Up Page Profile Page Team Page
Sign In Sign Up Profile Page Team Page
Notifications Posts Projects Page Milestones Page
Notification Posts Projects Page Milestone Page

Contribution Guidelines

πŸ‘‡ Prerequisites:

Pass

  • Ability to use Git and Github is mandatory
  • Working knowledge of Dart and Flutter
  • Basic knowledge of Firebase is a plus and willingness to learn more
  • UI/UX skills are appreciable but not mandatory

Suggested Resources for picking up on the skills:

Learn

Steps:

Steps

1. Fork this repository.

2. Clone your forked repository to your local system.

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

3. Navigate to the project directory.

cd community_app_boilerplate

4. Create a new branch.

git checkout -b <your_branch_name>

5. Make changes in source code.

6. Commit your changes.

  git add .
  git commit -m "<your_commit_message>"

7. Push your local branch to the remote repository.

git push -u origin <your_branch_name>

8. Create a Pull Request!

Congratulations! Sit and relax, you've made your contribution to Community App Boilerplate project.

Tasks:

Tasks

  • Improve the UI/UX of the app
  • Work on the pages of the app
  • Fix bugs
  • Add more features like speech to text,etc
  • Improve the documenation of the project
  • Create a GUIDE.MD file instruction which parts of the code base can be modified for someone to put in their own content and use the app per their needs
  • Firebase integration
  • Making Android and IOS applications
  • Publishing it on App Store
  • Work on additional projects for the community like mass mailer,certgen,etc

Code of Conduct:

Make sure you don't violate this

πŸ‘¨ Project Admin

Admin

Smaranjit Ghose

πŸ‘¬ Mentors and Project Maintainers

Project Maintainers

License πŸ“œ

License

MIT License

About

This is an open source project for creating a Flutter app that shall serve as a template/boilerplate for various technical communities, clubs, organizations, etc to use.

License:MIT License


Languages

Language:Dart 86.2%Language:Kotlin 6.8%Language:Swift 6.4%Language:Objective-C 0.6%