Stay informed!
This is very much a work-in-progress, and it should not be relied upon until it is stable. Once stable, this README will be updated accordingly.
If you want to clone this repository to your local computer and start contributing, you can follow these steps:
- Make sure you have
git,node, andnpminstalled on your computer. - From the command line,
cdinto an empty directory that you want to become your local repo. - Run
git clone https://github.com/next-app/next.git .to clone all the files into this directory. - Run
npm installto download all of the Node dependencies. - That's it! You can now navigate to
<local repo>/public/index.htmlin a browser and see the pages. - When you make changes to the Omelet code, you'll need to run
npm run buildto re-build the HTML and the templates. When you make changes to the CSS or non-template JavaScript, you don't need to do this.