Star+
This project is based on the Star+ website just to practice and learn new concepts about web development layouts and styling. It is a Single Page Application created with VanillaJS and Custom Elements.
Tech Stack
- Platform: Node.js v16+.
- NextJS
๐ผ . - GSAP ๐ฆธ๐ป.
- Styled Components ๐ ๐ป.
- Firebase
๐ก . - Storybook
๐ . - Jest & React Testing Library
๐งช . - Code lint and style: eslint, stylelint, standardjs.
- Commitlint & Commitizen.
Local Development
In your code editor or IDE, install their respective plugins/packages so you can see in realtime the recommendations while writing code.
Deployment
The deployment is being managed through Netlify.
Once your changes are merged in main
visit star-plus.netlify.app/ .
Getting Started
nvm use
npm i
npm run dev
- Open the http://localhost:3000/ in your favorite browser.
How to contribute
Please follow the categories based on your changes for your branches/commits.
- feat: add a new feature with tests.
- update: improve a current feature with tests.
- fix: resolve a bugfix or issue with tests.
- docs: update documentation either in code comments or markdown files.
- chore: changes in building, testing, or any other workflow processes.
- release: release project breakpoint.
Branch strategy
category/#n-description
docs/#2-add-readme-structure
Commits strategy
category: #n message description
docs: #2 add readme structure
- Contributing
- Create a branch from
main
following the branch strategy. - Attach your commits to the Issue. The Issue must be created in the GitHub Project.
- Create a Pull Request, add Reviewers & Labels.
Authors
- @Jaimeandres97
- @juancho11gm
Made with <3.
This is a Next.js project bootstrapped with create-next-app
.