README
¶
Litmus Chaos Community Chart Hub
Development Setup
Prerequisite
- Golang is installed and configured, If not follow the instructions here.
- Install Node.js and npm. Follow the instructions here.
- Repo should be cloned to your go path, repo path should be
$GOPATH/src/github.com/litmuschaos/charthub.litmuschaos.io
Tech Stack from Frontend
- Material-UI
- Typescript
- React
- Redux
- Redux-Thunk
- Redux-Persist
- React Router
- Redux DevTools Extension
- PWA Support
Tech Stack from Backend
Start Frontend
Install it and run:
cd app/client
npm i
npm start
Build it and serve:
cd app/client
npm run build
npm install -g serve
serve -s build
Enable PWA ServiceWorker [OPTIONAL]
Just comment in the following line in the index.tsx:
// registerServiceWorker();
to
registerServiceWorker();
Start Backend Server
cd app/server
go run main.go
The backend go server will be up and running on port 8080
Dev setup: Enable Prettier [OPTIONAL]
- Step: Install the Prettier plugin (e.g. the one of Esben Petersen)
- Add the following snippet to your settings in VSCode:
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.organizeImports": true // optional
},
Usage
Open your browser and go to http://localhost:3000/ to access the frontend
Docker Setup
This project has been configured to run with docker, you can initialize the system by running
docker-compose up
This will setup the nginx and go server for you. To access the frontend use http://localhost/. You need to have docker and docker-compose installed to use this method.
Resources
Our Standup open community meeting link:
Feel free to drop by and participate in our discussion of new open source projects here
Figma Design document for the Front-end website:
View, review, give feedbacks and add comments, suggests upgrades, just about anything related to design right here
Visit our main Litmus repo:
Were are more than welcoming to a new contributor, pay a visit and star it for updates right here
License
Directories