Armada.nu is built upon Gatsby and Static CMS.
Static CMS is a Content Management System that provides a graphical interface to edit the website. It integrates with Netlify which is our deployment tool. Note that using the Static CMS panel to edit will always commit to master branch. Gatsby is a static site generator that creates a website out of what is created using the CMS.
You will need access though the Armada team to be able to contribute as a developer or writer. To contribute as a developer, start by cloning this repository.
git clone <url>
To clone using SSH you need to setup your SSH keys with GitHub (recommended). Otherwise you can clone using the HTTPS option instead with your username and password.
Please use any version of Node 18 with npm v.9.5.0
Installing node:
Please only use NVM, Node version manager as this will help it so that you can keep your current node version and that you can keep developing in case you need to update your local Node for other apps but keep developing in Node 18.
Windows
We recommend nvm-windows.
download-link.
nvm install 18
nvm use 18
If you already have a node version installed NVM will detect it and ask you to attach it Instaling NVM on Mac/Linux
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
Updating npm: In case your npm (after upgrading Node version) is still stuck on an old version please use
npm install -g npmRun this command to install the dependencies that armada.nu is built on. This only needs to be done the first time you download this repo, or after a new dependency has been added.
npm inpm install -g gatsby-cli
This will install gatsby-cli 5.7.0 check version by typing gatsby-cli -v Note that gatsby-cli could install locally for that Node meaning if you download another version in nvm you have to install gatsby-cli again
If gatsby-cli is not 5.7.0 use this instead:
npm install -g [email protected]
gatsby developThe site will be running att localhost:8000
You can find the Netlify CMS admin panel at localhost:8000/admin/
node-sass is a module which gives issues and varies depending on which Node you use.
Make sure that you have python installed and if gatsby develop doesn't work use
npm rebuild node-sass
Make sure that python is added to Path
To build for production there is a script available through Gatsby. This can be run manually to create a production ready site. Be sure to check that the build succeeds before attempting to merge your changes with master.
gatsby build##Linting The respository requires you to have Prettier and Eslint (for prettier) installed. Please install these extensions in Visual Code (or editor of your choice). You can set up so that the client does linting and formatting after save by going into the settings in Prettier. After you've finished programming run:
npm run lint
npx prettier --write .
-
Start developing.
Navigate into your new site’s directory and start it up.
gatsby develop
-
Open the source code and start editing!
Your site is now running at
http://localhost:8000!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.
A quick look at the top-level files and directories you'll see in a Gatsby project.
.
├── 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
-
/node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. -
/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”. -
.gitignore: This file tells git which files it should not track / not maintain a version history for. -
.prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent. -
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. -
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). -
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. -
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. -
LICENSE: Gatsby is licensed under the MIT license. -
package-lock.json(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). -
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. -
README.md: A text file containing useful reference information about your project.
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.
