-
Install yarn
This starter expects to use yarn to manage dependencies, so go install it.
-
Copy the Next.js starter
Clone the repository:
git clone https://github.com/protw/azreal.git azreal
-
Start developing.
Navigate into your new site’s directory and start it up.
cd azreal/ui # Install depdendencies. yarn # Start the dev server yarn dev
-
Open the source code and start editing!
Your site is now running at
http://localhost:3000!Open the
azrealdirectory in your code editor of choice and editsrc/pages/index.tsx. Save your changes and the browser will update in real time!
A quick look at the top-level files and directories you'll see in this project. . ├── .eslintrc.js ├── .gitignore ├── .next/ ├── .prettierrc ├── LICENSE ├── README.md ├── next.config.js ├── node_modules/ ├── package.json ├── public/ ├── src/ ├── tsconfig.json └── yarn.lock
-
.eslintrc.js: This file configures ESLint, which will check the code for potential problems and style issues. It also integrates with Prettier for formatting. -
.gitignore: This file tells git which files it should not track / not maintain a version history for. -
.next: Thenextcommand line tool uses this for various purposes. You should never need to touch it, but you can delete it without causing any problems. -
.prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent. -
LICENSE: Gatsby is licensed under the MIT license. -
README.md: A text file containing useful reference information about your project. -
next.config.js: This file customizes the Next.js build process so that it can work with EUI. -
node_modules/: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. -
package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project. -
public/: Files that will never change can be put here. This starter project automatically puts EUI theme files here during the build -
src/: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template.srcis a convention for “source code”. -
tsconfig.json: This file configures the TypeScript compiler -
yarn.lock(Seepackage.jsonbelow, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly, but you need to commit any changes to git).