axiomstudio/studio

Axiom Studio - Studio

This is the client side web app for https://github.com/axiom-studio/studio. This web app is written in https://react.dev/ frontend-library. Uses a typescript + vite for setup.

Local Development

This project uses yarn as package manager. By default, the backend is pointed to -. To change it, update the TARGET_URL in ./vite.config.mts to your axiom studio instance url.

• To install all dependencies and initialize the project just run the command:

bash
yarn install

• To start a dev server at http://localhost:3000, execute:

bash
yarn start

Check out package.json for more scripts.

Commit Process

• We use husky to run compile and lint-staged before commit staged changes
• If husky finds any errors during either the compilation stage or linting stage, the atte*** to commit will fail
• To fix auto-fixable issues, execute:

bash
yarn lint-fix

Do's

• Try to make only one state per page rest every thing shall be pure.
• A method should do one and only one thing.
• Do function and variable namings so good you don't need comments.
• While making smaller Components make them reusable.
• Do most of the heavy lifting tasks inside smaller components not in the state component.
• Do all the parsing and error handling on service state component should not get anything more than (success and data) or (error and data).
• Use BEM to name CSS classes and structure it.

Don'ts

• Don't add if else on render add functions which render checks on smaller functions.
• Don't add IDs for CSS, if done correctly you never need ids.
• Don't add unnecessary Indentations, it doesn't improve readability.
• Never add checks on the basis of text.
• Don't use float use display instead, use display flex-box, inline, inline-block.
• Don't use mix type methods in a class

How do I make a contribution?

Never made an open source contribution before? Wondering how contributions work in our project? Here's a quick rundown!

• Find an issue that you are interested in addressing or a feature that you would like to add.
• Fork this repository to your local GitHub organization. This means that you will have a copy of the repository under your-GitHub-username/repository-name.
• Clone the repository to your local machine using:

bash
git clone https://github.com/github-username/dashboard.git

• Create a new branch for your fix using git checkout -b branch-name-here.
• Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
• Use git add insert-paths-of-changed-files-here to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
• Use git commit -m ‘Insert a short message of the changes made here’ to store the contents of the index with a descriptive message.
• Push the changes to the remote repository using git push origin branch-name-here.
• Submit a pull request to the upstream repository.
• Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so fix: Added failsafe check to resolve #1423.
• In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
• Wait for the pull request to be reviewed by a maintainer.
• Make changes to the pull request if the reviewing maintainer recommends them.
• Celebrate your success after your pull request is merged!