README.md

Aquarius

A Typescript fork of GatsbyJS bootstrapped with frontend optimization tools for development and production.

Visit the stater template demo

🚀 Quick Start

1. Create an Aquarius site.

   Use the Gatsby CLI to create a new site, specifying the default starter.

   # create a new Aquarius project using the default starter
   git clone  https://github.com/liontechnyc/Aquarius.git <project-name>

2. Start developing.

   Navigate into your new site’s directory and start it up.

   npm run develop

3. Open the source code and start editing!

   Your site is now running at http://localhost:5000!

   Note: You'll also see a second link: http://localhost:5000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

   Open the project directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── scripts
├── src
├── test
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── jest.config.js
├── LICENSE
├── package-lock.json
├── package.json
├── README.md
├── tsconfig.json
└── tslint.json

1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2. /scripts: This directory contains utility scripts e.g static image optimization.

3. /test: This directory contains testing utilities and Jest preprocessing.

4. /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”.

5. .gitignore: This file tells git which files it should not track / not maintain a version history for.

6. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

7. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

8. 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 for more detail).

9. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

10. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

11. jest.config.js: Jest testing framework configuration.

12. LICENSE: Aquarius is licensed under the GPLv2 license.

13. 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).

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

15. README.md: A text file containing useful reference information about your project.

16. tsconfig.json: Typescript compiler configuration (see reference).

17. tslint.json: Typescript linter configuration (see reference).

scripts

# Execute scripts with NPM
npm run <script>

Script	Function
build	Compile project for production and distribution
develop	Run development server on port 5000
format	Lint the codebase and assert style pattern
lint-staged	Same as format however, specifically for use with Git Hooks
start	Same as develop
serve	Serve production build locally; great for staging development builds
stage	Optimzes assets, builds then serves the app locally ideal for QA testing SSR behavior
clean	Clean artifacts from build and develop
test	Run unit test
optimize	Optimize static images for web and mobile; in src/images
type-check	Assert Typescript typings

• You may have to run npm start twice due to a glitch with the sharp and gatsby-plugin-manifest modules. Use this remedy only if it hangs on non-square images compilation *

🎓 Learning Aquarius

Aquarius essentially forks Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

• For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

• To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

🔋 Batteries Included

• Built in pages for Cookies Policy and Privacy Policy found respectively at /cookies and /privacy routes. To edit these refer to src/templates and src/markdown. These templates are injected via the Gatsby Node API so refer to gatsby-node.js for its configuration.

💫 Deploy