Skip to content

Commit

Permalink
Merge branch 'release/v0.7'
Browse files Browse the repository at this point in the history
  • Loading branch information
syuChen1 committed Jun 14, 2021
2 parents 4c0250b + 7b42fcf commit d703ecc
Show file tree
Hide file tree
Showing 87 changed files with 31,711 additions and 19,478 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Story:**
A clear and concise description of the feature from the perspective of the main user.

**Implementation**
A clear and concise description of the feature from the developers point of view.

**Client/Server/Compile/Database**
Choose one of the above and break goals down into individual tasks with checkboxes next to them. One issue may include multiple tasks for multiple of the above categories

**Additional context**
Add any other context or screenshots about the feature request here.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,15 @@ Cloud-based programming interface
The development environment is composed of five servers. The first one is run with the [Create React App](https://create-react-app.dev/docs/getting-started/) dev server. The later four are containerized with docker and run with [docker compose](https://docs.docker.com/compose/).

* `casmm-client-dev` - localhost:3000

* `casmm-server-dev` - localhost:1337

* `casmm-compile-dev`

* `casmm-db-dev` - localhost:5432

> The first time the db is started, the [init_db.sh](/scripts/init_db.sh) script will run and seed the database with an environment specific dump. Read about Postgres initialization scripts [here](https://github.com/docker-library/docs/blob/master/postgres/README.md#initialization-scripts)
* `casmm-compile_queue-dev`

#### Running
Expand All @@ -56,6 +62,7 @@ The development environment is composed of five servers. The first one is run wi
3. Run `docker-compose up` from `/`

> Grant permission to the **scripts** and **server** directories if you are prompted

### Staging

Expand Down Expand Up @@ -87,6 +94,22 @@ The production environment is a Heroku app. It is composed of a web dyno, compil

<br/>

## Maintenance

All three components of the application have their own dependencies managed in their respective `package.json` files. Run `npm outdated` in each folder to see what packages have new releases. Before updating a package (especially new major versions), ensure that there are no breaking changes. Avoid updating all of the packages at once by running `npm update` because it could lead to breaking changes.

### Strapi

This is by far the largest and most important dependency we have. Staying up to date with its [releases](https://github.com/strapi/strapi/releases) is important for bug/security fixes and new features. When it comes to actually upgrading Strapi make sure to follow the [migration guides](https://strapi.io/documentation/developer-docs/latest/migration-guide/#instructions)!

<br/>

## CI/CD

All of the deployments and releases are handled automatically with [GitHub Actions](https://docs.github.com/en/actions). The workflows implement custom [Actions](https://github.com/STEM-C/CaSMM/actions) that live in the [auto](https://github.com/STEM-C/auto) repo.

<br/>

## Contributing

### Git Flow
Expand Down Expand Up @@ -120,4 +143,3 @@ Before submitting a pull request, merge the target branch into the working branc

- PRs to **master** should squash and merge
- PRs to all other branches should create a merge commit

1 change: 1 addition & 0 deletions client/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock.json
5 changes: 3 additions & 2 deletions client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"@testing-library/react": "^9.3.2",
"@testing-library/user-event": "^7.1.2",
"antd": "^4.3.5",
"axios": "^0.19.2",
"axios": "^0.21.1",
"craco-less": "^1.17.0",
"cross-env": "^7.0.2",
"emoji-picker-react": "^3.2.1",
Expand All @@ -19,7 +19,8 @@
"react-dom": "^16.13.1",
"react-papaparse": "^3.7.0",
"react-router-dom": "^5.1.2",
"react-scripts": "3.4.1"
"react-scripts": "3.4.1",
"yarn": "^1.22.10"
},
"scripts": {
"start": "craco start",
Expand Down
1,327 changes: 1,229 additions & 98 deletions client/public/lib/arduino_compressed.js

Large diffs are not rendered by default.

Loading

0 comments on commit d703ecc

Please sign in to comment.