Giter VIP home page Giter VIP logo

website's Introduction

AvdanOS.com Website

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    

Banner

pages-build-deployment NPM Dev site Deploy NPM Dev site CI/CD

Project Structure

  • ./src contains the nextjs source code for the website.
  • ./cdn contains the raw cdn files that auto deploy to cdn.avdanos.com

Getting Started

Make sure you have NodeJS 14 or later installed.

$ cd src
$ npm install
$ npm run dev

Then 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.

Contribution

Compatibility

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.

Code Quality

For tsx, please follow the Airbnb style guide. For CSS, please follow this guide.

Pull Request

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.

website's People

Contributors

astroneural avatar azproductions avatar detherminal avatar dynamiccode1 avatar froxcey avatar gggaming71 avatar linuxjava7 avatar mrserge01 avatar piratebay298 avatar pranavpk404 avatar stonemcyt avatar trynera avatar yegender124001 avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.