https://github.com/zenitheesc/zenith-website
Zenith Aerospace's home on the web.
https://github.com/zenitheesc/zenith-website
cubesat documentation nextjs open-source react vercel web zenith
Last synced: 4 months ago
JSON representation
Zenith Aerospace's home on the web.
- Host: GitHub
- URL: https://github.com/zenitheesc/zenith-website
- Owner: zenitheesc
- License: mit
- Created: 2021-01-25T00:22:55.000Z (about 5 years ago)
- Default Branch: production
- Last Pushed: 2024-04-22T12:42:41.000Z (almost 2 years ago)
- Last Synced: 2024-04-22T13:54:10.190Z (almost 2 years ago)
- Topics: cubesat, documentation, nextjs, open-source, react, vercel, web, zenith
- Language: JavaScript
- Homepage: https://zenith.eesc.usp.br
- Size: 170 MB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ZenSite 2021
Reimagining Zenith's web presence through a modern website that respects the group's technical knowledge and passion for development. We're a student group based in Brazil, we develop open software and hardware. #AdAstraPerAspera
Environment and Tools •
Steps to run and debug •
How to contribute?
## Environment and tools
- [Next.js](https://nextjs.org/): ^10.0.6,
- [React](https://reactjs.org/): ^17.0.1,
- [npm](https://www.npmjs.com/get-npm): ^7.5.4,
- [node](https://www.npmjs.com/get-npm): ^15.8.0,
We're using [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for linting/formatting.
## Steps to run and debug
- (recommended) `npm run dev` to compile it in development mode and run it on localhost:3000.
- `npm run build` to create an optimized production build
- `npm start` to run the production build on localhost
## How to contribute
Check out our [figma](https://www.figma.com/file/eA9iZxhtQnhIC5erngA2CY/Prot%C3%B3tipos-Zenith?node-id=0%3A1).
Report bugs and/or feature-requests on our [_issue tab_](https://github.com/zenitheesc/zenith-website/issues). Maybe there's something there waiting for you to work on!
### Gitflow **Holy** Rules
- **Never commit directly into the Production branch**;
- **Always** run `git fetch && git status`, especially before merging (also run it on the branch you're trying to merge to) or pushing (I always run it every 5 minutes or so);
- Create a branch to work on;
- Name your branches according to their function. ex: "feature/feature-name"
- **Before** merging into Develop, **TEST** your implementation (is it responsive?);
### Naming conventions
- **Variables**: camelCase;
- **Functions**: camelCase;
- **Classes**: PascalCase;
- **Archives**: PascalCase;
- **Folders**: kebab-case;
### Linting and formatting
We're using [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for linting/formatting.
Specific details can be found on `.eslintrc.json` and `.pretierrc.js`
---
