repo-name Database | CSIS

Quick Start Instructions

This repo uses node v16.9.1 (npm v8.4.1) Data coming from https://docs.google.com/spreadsheets/d/e/update-id-here/pub?output=csv Clone & Install the dependencies...

git clone git@github.com:CSIS-iLab/database-table-template.git
cd repo-name-database
npm install

...then start Rollup:

npm run dev

Navigate to localhost:8080. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

---

Building and running in production mode

To create an optimised version of the app:

npm run build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

---

Branching

When modifying the code base, always make a new branch. Unless it's necessary to do otherwise, all branches should be created off of main.

Branches should use the following naming conventions:

Branch type	Name	Example
New Feature	feature/<short description of feature>	feature/header-navigation
Bug Fixes	bug/<short description of bug>	bug/mobile-navigation
Documentation	docs/<short description of documentation being updated>	docs/readme
Code clean-up/refactoring	refactor/<short description>	refactor/apply-linting
Content Updates	content/<short description of content>	content/add-new-posts

When ready to merge, submit a Pull Request into main. All code will be reviewed by the lead developer on the project before being merged into main.

Commit Messages

Write clear and concise commit messages describing the changes you are making and why. If there are any issues associated with the commit, include the issue # in the commit title.

CSS Styles

This project uses the BEM naming convention.

Copyright / License

Copyright © 2022 CSIS iDeas Lab under the License.