mouse-phenome-db

A repository for JAX Mouse Phenome DB project.

Onboarding and Development

Clone Repo to local: git clone https://github.com/FrancesLiu27/mouse-phenome-db

Go into the cloned project: cd mouse-phenome-db

Go into the app folder: cd mpd-app

Install the required packages: npm install

Start serving by running: npm start

The app will be served at: http://localhost:3000/

Development

1. Make sure the local main branch is up-to-date:

   a. Checkout main branch: git checkout main

   b. Pull changes to local: git pull

2. Develop a new feature:

   a. Checkout new branch: git checkout -b {name/branchName}, for example: git checkout -b xue/create-app

   b. Push the new branch to git: git push

   c. Make changes and test in local by running npm start

   d. After changes are completed, use git add ., git commit -m 'message', and git push to push changes

3. Create a Pull Request:

   a. Compare your branch to the main branch to create a new PR

   b. Follow the PR template and fill in the information

   c. [Optional] Specify reviewers for second opinions

   d. Merge branch

Project Documentation

1. Project Requirment Doc:

https://docs.google.com/document/d/19bh-Ckpv2oqrwQCX8c4VXT92D2CF8bGPqp0E5uroF1I/edit

2. Project Proposal:

https://docs.google.com/document/d/1BsdtF4ajGhNdKeNOJQBxgATawk0vxhPoZ6WSt-DHiuQ

3. Team Organization and Process Model:

https://docs.google.com/document/d/1BObhm4vwC5rDXwFQyYrCZtiN6ia2DhN_ONpqO_yjCZM/edit

4. Software Design Description (SDD):

https://docs.google.com/document/d/1dJlCLSKFwthhJ9D4V7zrd65SuC_AGS2hdn2N3b8AiBY/edit

5. SE Testing Documentation for MPD Navigation Redesign:

https://docs.google.com/document/d/1yAunNahqZkmY_Dv8MKO6oZqK4C0uIxD3CRbuTJguQf8/edit

6. Individual Contribution Assessment:

https://docs.google.com/document/d/1rDNmekYLewLzv3nxeZuarVJcn44aIzbGXFrHLtSfgH0/edit

7. Team Evaluation of Project:

https://docs.google.com/document/d/1iz5dkkdFuAV2MQi4495PPBRnYzl8gDa5ltoIntoL54k/edit

Other Important Links

1. Development Backlog:

https://www.notion.so/Mouse-Phenome-Database-Task-Board-bab5066f41a7404dad327b09f58c2b45

2. Team Meeting Notes:

https://docs.google.com/document/d/1OrmTYyV84kaveFR1EbgNd94RPgOX2xJfNSeXJIXwOCc/edit

3. Team Member Assignment and Contract:

https://docs.google.com/document/d/1fB_Q6WNHVYmmjvEnjlMcipEdf_FMYtg6naZBfNwi6sQ/edit

4. Mock Design from Jackson Labs:

https://drive.google.com/file/d/1uINLix0gQHR7Dimzbp9WP7Wb8rgRBjQb/view