The AvdanOS homepage is built using NextJS and GeistUI, which support both Markdown and JavaScript to fit the needs of the contributors to the project.
| avdan-os.github.io's code is in the dev branch. Commits to the main branch will be ignored. |
CONTRIBUTE |
|---|
./srccontains the nextjs source code for the website../cdncontains the raw cdn files that auto deploy to cdn.avdanos.com
Make sure you have NodeJS 14 or later installed.
$ cd src
$ npm install
$ npm run devThen head over to localhost:3000 to see the site live!
The page will reload if you make edits.
You will also see any lint errors in the console.
Makesure everything works on mobile before merging. To make a page compatible with all width, there is a hook '@/lib/dynamic-width' import it and use it to make the page adaptive.
Also, test on at least two browser engines (eg. Firefox with gecko engine and Brave based on Chromium project).
If things don't fully work and you want to release a beta to the public, you can also make the page opt in beta page (see the BetaPopup component) or show a warning message (indecating to the user that it is likely to break).
If you are making a page without the help of any designer or other developers, try to follow the design. This can be easily done by using the geist-ui and not change too much properties.
For tsx, please follow the Airbnb style guide. For CSS, please follow this guide.
It's recommended that you have a concise list of change when making pull request to make the review process faster. Also, makesure the page builds on your fork before making a pull request.
Again, remember to use dev branch!!! Committing to master branch will be automatically overwritten.