Verified Commit 62a7bdf9 authored by Sandro Lutz's avatar Sandro Lutz
Browse files

Update README

parent 9b669afe
<!-- AUTO-GENERATED-CONTENT:START (STARTER) -->
<p align="center">
<a href="https://www.gatsbyjs.org">
<img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="60" />
</a>
</p>
<h1 align="center">
Gatsby's default starter
</h1>
<a href="https://amiv.ethz.ch">
<img alt="amiv" src="./src/images/logos/amiv.svg" width="200" style="position:relative;left:-20px;" />
</a>
Kick off your project with this default boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React.
# amiv Website
_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._
This is the home of the amiv website.
## 🚀 Quick start
1. **Create a Gatsby site.**
1. **Development**
Use the Gatsby CLI to create a new site, specifying the default starter.
Navigate into the project directory, install all dependencies and run the development server using the following commands:
_Please note that the parameter `-g` is optional. It is used to install the package `gatsby-cli` globally on the system._
```shell
# create a new Gatsby site using the default starter
gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default
npm install -g gatsby-cli
npm install
gatsby develop
```
1. **Start developing.**
You can visit the website now under http://localhost:8000
2. **Linting & Formatting**
Navigate into your new site’s directory and start it up.
We use `eslint` and `prettier` for linting and formatting of the javascript code. You can use the following commands:
```shell
cd my-default-starter/
gatsby develop
npm run eslint
npm run format
```
1. **Open the source code and start editing!**
3. **Production Build**
Your site is now running at `http://localhost:8000`!
You can prepare a production build manually and serve it using gatsby's built-in webserver. This will run the server-side rendering part.
_Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._
It is very possible, that some things do not work correctly when ssr is used, so you should definitively test this one before deploying a new version!
Open the `my-default-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!
```shell
gatsby build
gatsby serve
```
For more information about deployment, read the section about deployment below.
## 🧐 What's inside?
A quick look at the top-level files and directories you'll see in a Gatsby project.
A quick look at the most important files and directories of this Gatsby project.
```ascii
.
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── config.development.js
├── config.production.js
└── src
├── components
├── context
├── images
├── intl
├── markdown
├── pages
├── store
├── utils
└── theme.js
```
1. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/). These allow customization/extension of default Gatsby settings affecting the browser.
.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md
2. **`gatsby-config.js`**: This is the main configuration file for the Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).
1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
3. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
2. **`/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. `src` is a convention for “source code”.
4. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/). These allow customization of default Gatsby settings affecting server-side rendering.
3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
5. **`config.development.js` / `config.production.js`**: This file contains configuration values used with our custom components and pages.
4. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.
6. **`/src`**: This directory contains all source code.
5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
1. **`/src/components`**: This directory contains all components used somewhere on the website.
2. **`/src/context`**: This directory contains all custom [React Context](https://reactjs.org/docs/context.html)
3. **`/src/images`**: This directory contains all static images.
4. **`/src/intl`**: This directory contains all translation files used by `react-intl`.
5. **`/src/markdown`**: this directory contains markdown source files used on specific pages.
6. **`/src/pages`**: Every `js` file represents a page which path is exactly like the folder structure and filename.
6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).
_Example: A file at `/src/pages/amiv/about` will create a page at the path `/amiv/about`._
7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
7. **`/src/store`**: This directory contains all files related to data handling using `react-redux`.
8. **`/src/utils`**: Collection of utility functions.
8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.
## 💫 Deployment
9. **`LICENSE`**: Gatsby is licensed under the MIT license.
TODO: Add information about the deployment process of the project.
10. **`package-lock.json`** (See `package.json` below, 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).**
## ⚙ Technologies
11. **`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.
### Frontend Frameworks & Libraries
12. **`README.md`**: A text file containing useful reference information about your project.
* [Gatsby](https://www.gatsbyjs.org)
* [React](https://reactjs.org/)
* [react-intl](https://github.com/formatjs/react-intl)
* [React-Redux](https://react-redux.js.org/)
## 🎓 Learning Gatsby
### Backend
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
* [AMIV API](https://github.com/amiv-eth/amivapi)
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
### Build Tools
- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
* [NPM](https://www.npmjs.com/)
* [gatsby-cli](https://www.npmjs.com/package/gatsby-cli)
## 💫 Deploy
### Development Tools
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-default)
* [ESlint](https://github.com/eslint/eslint)
* [Prettier](https://github.com/prettier/prettier)
<!-- AUTO-GENERATED-CONTENT:END -->
Most IDEs have plugins for those tools. VS Code is the recommended IDE.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment