https://github.com/ialopezg/boilerplate
One platform to rule and control all business logic
https://github.com/ialopezg/boilerplate
backend
Last synced: 2 months ago
JSON representation
One platform to rule and control all business logic
- Host: GitHub
- URL: https://github.com/ialopezg/boilerplate
- Owner: ialopezg
- License: mit
- Created: 2021-09-23T20:01:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-25T23:47:19.000Z (about 3 years ago)
- Last Synced: 2025-01-20T01:31:57.942Z (4 months ago)
- Topics: backend
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
> One platform to rule and control all business logic
[](#contributors-)
[](http://makeapullrequest.com)
[](https://opensource.org/licenses/MIT)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/ialopezg/.github/blob/master/CODE_OF_CONDUCT.md)
## Features ✨
### Modules
| Repository | Issues | Pull Requests | Stars |
|:---------- |:------ |:------------ |:----- |
| **[ialopezg/api-boilerplate](https://github.com/ialopezg/api-boilerplate)** | [](https://github.com/ialopezg/api-boilerplate/issues) | [](https://github.com/ialopezg/api-boilerplate/pulls) | [](https://github.com/ialopezg/api-boilerplate) |
| **[ialopezg/administrator](https://github.com/ialopezg/administrator)** | [](https://github.com/ialopezg/administrator/issues) | [](https://github.com/ialopezg/administrator/pulls) | [](https://github.com/ialopezg/administrator) |
### Microservices
| Repository | Issues | Pull Requests | Stars |
|:---------- |:------ |:------------ |:----- |
| **[ialopezg/mailer](https://github.com/ialopezg/mailer)** | [](https://github.com/ialopezg/mailer/issues) | [](https://github.com/ialopezg/mailer/pulls) | [](https://github.com/ialopezg/mailer) |
## Getting started ✨
```bash
# 1. Clone the repository
git clone https://github.com/ialopezg/boilerplate.git
# 2. Enter your newly-cloned folder
cd boilerplate
# 3. Update latest repository commits from origin
git submodule update --remote --merge
# 4. Sync modules
git submodule sync
# 5. Enter desire repository and follow the instructions inside the repository chosen.
# 6. Read the documentation linked for each module for more details.
```
## Documentation ✨
Each module project includes a `docs` folder with more details.
## Development Phases
This section describes the phases of development where we will have "Major" version releases. A product of this size is never built in one go, in fact, the separate components as shown above is not even built to completion in any phase. We've moved away from Waterfall a while back and the most successful software companies do incremental work / updates given we're almost the only field in engineering that can do that without any additional cost. We'll have multiple phases marked by specific functionality being in that phase which will give us a nice break down of what to work on in order to complete the development of this application.
The phases are all dependent on the architecture showed above, the parts with the most dependencies will most likely be built first so we can allow for multiple other parts to be worked on as well. Lets go over a basic high level view of some of the phases.
### Phase 0: Technical architecture overview and technology stack setup
This is the high level technical phase of the planning that was done above. We need to establish how we will be building these management services, how they will be deployed, how the source code will be managed and how we plan on extending functionality / deprecating older functionality. This is an important part since the services will be the major feature of the project. We are skilled at developing client applications, and stacked is our preferred architecture, with this planning we'll need to setup the backend in such a way that it's easy to unit test, easy to deploy, easy to manage, easy to update and easy to debug in the live production state.
This phase will be concluded when we have a detailed plan of the technical setup and technical architecture overview as well as the deployment and technology stack overview.
### Phase 1: Technical Internal overview and data storage structure
In this phase we want to go over all the functionality we're looking at adding into each project. This will illuminate how we have to build the inter communication methods as well as the models that we'll require to build all the functionality. We will walk through the most important processes required and do a highlevel step list of how the data will move from the client through our backend and back to the client. When this is complete is necessary identify key models and decides on which properties will be useful to have in the application.
A success for this phase will be a detailed breakdown of one of the key processes, which models will be in the application as well as the purpose they serve, their properties and in which parts of the system they will be used in. This will give us a decent framework to criticise in an engineering meeting to make sure we have no gaps in our system.
### Phase 2: Data population and development prep
In this phase we are still not writing code haha. Planning and structure is important for such a large system, and we're still going to miss things. Here we will use the models defined above and generate some fake data for use to use when we finally do start the development. This process will give us a first review of our database structure we defined above and will show any flaws that we might have made in terms of how to store everything. This will also be very helpful during the development to ensure that we have data to work it.
A success for this phase will be a database with enough information in it to allow us to display some basic product when we get to that point.
### Phase 3: Customer App Setup and Authentication
Here we will create the mobile flutter project and setup firebase authentication. We will also make sure that when a user signs up we create them a profile on the database where we can manage all their information. This will be profile information for us to identify who we're communicating with.
A success for this phase will be a flutter app where we can sign in. A folder with a firebase project for user management that contains the cloud function to create a new user model entry in firestore when the user is created. A firebase app setup to allow for authentication.
### Phase 4: Which information do we show?
Usually in geolocation service it only shows devices that are between10 - 20 km radius. We need to build that system first before we can show devices to the user. For this we'll be using gmaps to get the users address and then use that locally to calculate which devices will be show.
## Support ✨
[Boilerplate Platform](https://github.com/ialopezg/boilerplate.git) is a MIT licensed project. It can grow thanks to the sponsors and support by the amazing backers.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
## License
Copyright © 2022 - Boilerplate Platform. This source code is licensed under MIT License found in the [LICENSE](LICENSE) file.
---
BOILERPLATE Platform - by [Isidro A. López G.](https://ialopezg.com/)
