This project is for Parents2Partners, developed by students of CCSU. This project is intended to be iterated on through multiple classes of student developers. This repo is a fork of the previous development team. Their upstream code base can be found here: https://github.com/Gulloje/R8MyTalkGulloje/R8MyTalk
If you are a future developer of this project, please fork this repo and continue development. There is no need to submit your changes upstream to this repo, though feel free to reach out to us with questions about the project. The previous developer provided us with a word document user manual that we will share with you.
The production application can be viewed here: https://r8temytalk-nkqs.onrender.com/ It is using a free hosting plan, and is normal for it to be slow to start up
- install nodejs LTS v20 for your platform via https://nodejs.org/en/download/
Follow these steps to set up a local development environment:
- create a folder that you want to use as your project directory
- cd to your project directory in a terminal
- clone the repo
git clone https://github.com/shawnmuzick/R8MyTalk.git
- dump the env file into the root of the cloned project, on the same level as this readme. Make sure the file is named ".env", if it is not.
- run the command to install the packages for the project:
npm install
- when the dependencies are finished installing, you can invoke node from a terminal and call the main application entry point:
node index.js
- the application will run on port 3000, by default. View the running application in your browser at localhost:3000
We will follow a conventional branching strategy:
main
|
- dev
| |
| - feat-{nameOfFeature}
| - feat-{nameOfFeature}
| - feat-{nameOfFeature}
|
- hotfix
When implementing a new feature, please create a branch from dev named as "feat-{nameOfFeature}". When the feature is complete, please submit a pull request into dev. The code will be reviewed and merged pending approval.
Main will be linked with the production environment.
Please use conventional message prefixes:
feat – new feature
fix – bug fix
chore – bump dependencies, update docs, etc
refactor – refactoring code
test – create new tests or fix existing ones
revert – revert some previous commit
BiomeJS is used as the linter for this project. You can check the configuration in biome.json Of note, the noForEach rule is disabled. The is beause the ForEach method used on FireBase objects is a cutom method on that object by the module developers (Google). They are not iterable by the language, and thus for...of will fail.