Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Layer5-Leaderboard] Transfer of the Leaderboard Code to the discuss-board repo #29

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING-gitflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ While this isn't an absolutely necessary step, if you plan on doing anything mor

## Add 'upstream' repo to list of remotes
```
git remote add upstream https://github.com/layer5io/meshery.git
git remote add upstream https://github.com/layer5io/discuss-board.git
```
("meshery" is used as the example repo. Be sure to reference the _actual_ repo you're contributing to e.g. "meshery-linkerd").

Expand Down
19 changes: 5 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,30 +55,21 @@ Please contribute! Layer5 documentation uses Jekyll and GitHub Pages to host doc

1. Create a fork, if you have not already, by following the steps described [here](./CONTRIBUTING-gitflow.md)
1. In the local copy of your fork, navigate to the docs folder.
`cd docs`
`cd leaderboard`
1. Create and checkout a new branch to make changes within
`git checkout -b <my-changes>`
1. Edit/add documentation.
`vi <specific page>.md`
1. Run site locally to preview changes.
`make site`
`npm start`
1. Commit, [sign-off](#commit-signing), and push changes to your remote branch.
`git push origin <my-changes>`
`git push <remote-name> <my-changes>`
1. Open a pull request (in your web browser) against the repo.


#### Tests
Users can now test their code on their local machine against the CI checks implemented using `make run-tests`.

To test code changes on your local machine, run the following command:
```
make run-tests
```

#### Building Docker image
To build a Docker image of the project, please ensure you have `Docker` installed to be able to build the image. Now, run the following command to build the Docker image:
### Build and Run Leaderboard Locally
```sh
make docker
make run
```

### UI Lint Rules
Expand Down
31 changes: 11 additions & 20 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,24 +1,15 @@
check:
golangci-lint run
LEADERBOARD_DIR := leaderboard
PORT := 3000

check-clean-cache:
golangci-lint cache clean
# Commands
install:
@echo "Installing dependencies..."
cd $(LEADERBOARD_DIR) && npm install

protoc-setup:
wget -P meshes https://raw.githubusercontent.com/layer5io/meshery/master/meshes/meshops.proto
start:
@echo "Starting the site on port $(PORT)..."
cd $(LEADERBOARD_DIR) && npm start

proto:
protoc -I meshes/ meshes/meshops.proto --go_out=plugins=grpc:./meshes/
run: install start





site:
$(jekyll) serve --drafts --livereload

build:
$(jekyll) build --drafts

docker:
docker run --name site -d --rm -p 4000:4000 -v `pwd`:"/srv/jekyll" jekyll/jekyll:4.0.0 bash -c "bundle install; jekyll serve --drafts --livereload"
.PHONY: install start run
1 change: 1 addition & 0 deletions leaderboard/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
REACT_APP_BASE_URL=https://discuss.layer5.io/
23 changes: 23 additions & 0 deletions leaderboard/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
7 changes: 7 additions & 0 deletions leaderboard/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"endOfLine": "lf",
"printWidth": 80,
"tabWidth": 2,
"trailingComma": "es5",
"singleQuote": true
}
37 changes: 0 additions & 37 deletions leaderboard/AllUsers.html

This file was deleted.

26 changes: 26 additions & 0 deletions leaderboard/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
1 change: 1 addition & 0 deletions leaderboard/_ redirects
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/* /index.html 200
25 changes: 25 additions & 0 deletions leaderboard/craco.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import path from 'path';

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Absolute paths. 👍

module.exports = {
webpack: {
alias: {
'@components': path.resolve(__dirname, 'src/components'),
'@assets': path.resolve(__dirname, 'src/assets'),
'@constants': path.resolve(__dirname, 'src/constants'),
'@config': path.resolve(__dirname, 'src/config'),
'@pages': path.resolve(__dirname, 'src/pages'),
'@store': path.resolve(__dirname, 'src/store'),
'@hooks': path.resolve(__dirname, 'src/hooks'),
'@utils': path.resolve(__dirname, 'src/utils'),
'@features': path.resolve(__dirname, 'src/features'),
'@providers': path.resolve(__dirname, 'src/providers'),
'@types': path.resolve(__dirname, 'src/types'),
},
style: {
postcss: {
plugins: [require("tailwindcss"), require("autoprefixer"), require('postcss')],
},
},
},

};
43 changes: 0 additions & 43 deletions leaderboard/data.js

This file was deleted.

Loading