Skip to content

Commit 5f74033

Browse files
authored
Merge pull request #2 from oslabs-beta/dev
File cleanup
2 parents 8b63cbf + 29151a7 commit 5f74033

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+92
-253
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,5 @@ src/extension/build.pem
1313
bower_components
1414
sandboxes/manual-tests/NextJS/.next
1515
.vscode
16-
src/app/components/Map.tsx
1716
package-lock.json
1817
yarn.lock

CONTRIBUTING.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Welcome to the Reactime contributing guide!
22

3-
Thank you for investing your time in contributing to our project! :sparkles:.
3+
Thank you for investing your time in contributing to our project! :sparkles:.
44

55
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
66

@@ -13,16 +13,15 @@ To get an overview of the project, read the [README](README.md). Here are some r
1313
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
1414
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
1515

16-
1716
## Getting started
1817

19-
To navigate our codebase with confidence, see the [Developer Guidelines](/src/README.md) :confetti_ball:.
18+
To navigate our codebase with confidence, see the [Developer Guidelines](src/DEVELOPER_README.md) :confetti_ball:.
2019

2120
### Issues
2221

2322
#### Create a new issue
2423

25-
If you spot a problem with the docs, [search if an issue already exists](https://github.com/open-source-labs/reactime/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/open-source-labs/reactime/issues/new).
24+
If you spot a problem with the docs, [search if an issue already exists](https://github.com/open-source-labs/reactime/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/open-source-labs/reactime/issues/new).
2625

2726
#### Solve an issue
2827

@@ -32,14 +31,16 @@ Scan through our [existing issues](https://github.com/open-source-labs/reactime/
3231

3332
#### Make changes in the UI
3433

35-
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
34+
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
3635

3736
#### Make changes locally
3837

3938
1. [Install Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage).
4039

4140
2. Fork the repository.
41+
4242
- Using GitHub Desktop:
43+
4344
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
4445
- Once Desktop is set up, you can use it to [fork the repo](https://github.com/open-source-labs/reactime.git)!
4546

@@ -55,16 +56,17 @@ Commit the changes once you are happy with them.
5556
### Pull Request
5657

5758
When you're finished with the changes, create a pull request, also known as a PR.
58-
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
59+
60+
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
5961
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
6062
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
61-
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
63+
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
6264
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
6365
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
6466
- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
6567

6668
### Your PR is merged!
6769

68-
Congratulations :tada::tada: The Reactime team thanks you! :sparkles:.
70+
Congratulations :tada::tada: The Reactime team thanks you! :sparkles:.
6971

7072
Once your PR is merged, your contributions will be publicly visible on [Reactime](https://github.com/open-source-labs/reactime)!

demo-app-remix/package.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
"scripts": {
55
"build": "remix build",
66
"dev": "npm-run-all build --parallel \"dev:*\"",
7-
"dev:node": "cross-env NODE_ENV=development nodemon --require dotenv/config ./server.js --watch ./server.js",
7+
"dev:node": "cross-env NODE_ENV=development nodemon --require dotenv/config ./server.ts --watch ./server.ts",
88
"dev:remix": "remix watch",
9-
"start": "cross-env NODE_ENV=production node ./server.js",
9+
"start": "cross-env NODE_ENV=production node ./server.ts",
1010
"typecheck": "tsc"
1111
},
1212
"dependencies": {
@@ -19,7 +19,8 @@
1919
"isbot": "^3.6.5",
2020
"morgan": "^1.10.0",
2121
"react": "^18.2.0",
22-
"react-dom": "^18.2.0"
22+
"react-dom": "^18.2.0",
23+
"ts-node": "^10.9.2"
2324
},
2425
"devDependencies": {
2526
"@remix-run/dev": "^1.14.1",

demo-app-remix/server.ts

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,31 @@
1-
const path = require("path");
2-
const express = require("express");
3-
const compression = require("compression");
4-
const morgan = require("morgan");
5-
const { createRequestHandler } = require("@remix-run/express");
1+
export {}; //JR: added to fix this error message: 'server.ts' cannot be compiled under '--isolatedModules' because it is considered a global script file. Add an import, export, or an empty 'export {}' statement to make it a module.
2+
const path = require('path');
3+
const express = require('express');
4+
const compression = require('compression');
5+
const morgan = require('morgan');
6+
const { createRequestHandler } = require('@remix-run/express');
67

7-
const BUILD_DIR = path.join(process.cwd(), "build");
8+
const BUILD_DIR = path.join(process.cwd(), 'build');
89

910
const app = express();
1011

1112
app.use(compression());
1213

1314
// http://expressjs.com/en/advanced/best-practice-security.html#at-a-minimum-disable-x-powered-by-header
14-
app.disable("x-powered-by");
15+
app.disable('x-powered-by');
1516

1617
// Remix fingerprints its assets so we can cache forever.
17-
app.use(
18-
"/build",
19-
express.static("public/build", { immutable: true, maxAge: "1y" })
20-
);
18+
app.use('/build', express.static('public/build', { immutable: true, maxAge: '1y' }));
2119

2220
// Everything else (like favicon.ico) is cached for an hour. You may want to be
2321
// more aggressive with this caching.
24-
app.use(express.static("public", { maxAge: "1h" }));
22+
app.use(express.static('public', { maxAge: '1h' }));
2523

26-
app.use(morgan("tiny"));
24+
app.use(morgan('tiny'));
2725

2826
app.all(
29-
"*",
30-
process.env.NODE_ENV === "development"
27+
'*',
28+
process.env.NODE_ENV === 'development'
3129
? (req: any, res: any, next: any) => {
3230
purgeRequireCache();
3331

@@ -39,7 +37,7 @@ app.all(
3937
: createRequestHandler({
4038
build: require(BUILD_DIR),
4139
mode: process.env.NODE_ENV,
42-
})
40+
}),
4341
);
4442
const port: number | string = process.env.PORT || 3003;
4543

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
"David Bernstein",
5656
"David Chai",
5757
"David Kim",
58+
"David Moore",
5859
"Dennis Lopez",
5960
"Edar Liu",
6061
"Edwin Menendez",
@@ -73,7 +74,9 @@
7374
"James Nghiem",
7475
"Jasmine Noor",
7576
"Jason Victor",
77+
"Jesse Rosengrant",
7678
"Jimmy Phy",
79+
"John Banks",
7780
"Joseph Park",
7881
"Joseph Stern",
7982
"Josh Kim",
@@ -87,6 +90,7 @@
8790
"Kristina Wallen",
8891
"Kyle Bell",
8992
"Lance Ziegler",
93+
"Liam Donaher",
9094
"Lina Shin",
9195
"Mark Teets",
9296
"Mike Bednarz",
@@ -173,7 +177,7 @@
173177
"html-react-parser": "^5.0.11",
174178
"intro.js": "^7.2.0",
175179
"intro.js-react": "^1.0.0",
176-
"jsondiffpatch": "^0.6.0",
180+
"jsondiffpatch": "^0.5.0",
177181
"lodash": "^4.17.21",
178182
"node": "^18.12.1",
179183
"rc-slider": "^10.5.0",
File renamed without changes.

src/app/components/App.tsx renamed to src/app/App.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import React from 'react';
22
import { MemoryRouter as Router } from 'react-router-dom';
3-
import MainContainer from '../containers/MainContainer';
3+
import MainContainer from './containers/MainContainer';
44
import { ThemeProvider } from '@mui/material/styles';
5-
import theme from './theme';
5+
import theme from './styles/theme';
66

77
/*
88
'currentTab' is the current active tab within Google Chrome.

src/app/__tests__/ActionContainer.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ const customStore = configureStore({
132132
const render = (component) => rtlRender(<Provider store={customStore}>{component}</Provider>);
133133

134134
const MockRouteDescription = jest.fn();
135-
jest.mock('../components/RouteDescription', () => () => {
135+
jest.mock('../components/Actions/RouteDescription', () => () => {
136136
MockRouteDescription();
137137
return <div>MockRouteDescription</div>;
138138
});

src/app/__tests__/ErrorMsg.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React from 'react';
22
import { render, screen } from '@testing-library/react';
33
import '@testing-library/jest-dom'; // needed this to extend the jest-dom assertions (ex toHaveTextContent)
4-
import ErrorMsg from '../components/ErrorMsg';
4+
import ErrorMsg from '../components/ErrorHandling/ErrorMsg';
55

66
const props = {
77
loadingArray: [false],

src/app/__tests__/Loader.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React from 'react';
22
import { render } from '@testing-library/react';
33
import '@testing-library/jest-dom'; // needed this to extend the jest-dom assertions (ex toHaveTextContent)
4-
import Loader from '../components/Loader';
4+
import Loader from '../components/ErrorHandling/Loader';
55

66
describe('unit testing for Loader.tsx', () => {
77
test('renders a loading icon', () => {

0 commit comments

Comments
 (0)