Academics Letter
Academics letter website repository. The application has been bootstraped with gatsby-starter-netlify-cms head over that project for further overview of the project base.
Setup
Install yarn on your system: https://yarnpkg.com/en/docs/install
Environment Variables
Run cp .env.template .env and edit .env.development
Install dependencies
Only required on the first run, subsequent runs can use
yarnto both bootstrap and run the development server usingyarn develop. Since this starter using the netlify-lambda, there could be further issues you, please check the Readme for further information and set up questions.
yarnForms
TBD
Available scripts
start
Starts the development server. This task runs both the start:app and start:lambda scripts.
Usage
yarn startbuild
Build the static files into the public folder, turns lambda functions into a deployable form. This task runs both the build:app and build:lambda scripts.
Usage
yarn buildclean
Removes all the files from public, .cache directories using the rimraf command.
Usage
yarn cleandevelop
Runs the clean script and starts the gatsby develop server using the command gatsby develop. Since this is not starting the lambda server it can be used when you only changing the site and not the lambda functions.
Usage
yarn developserve
This command is shorthand for gatsby serve
Usage
yarn servetest
Not implmented yet
Usage
yarn testformat
Formats code and docs according to our style guidelines using prettier
Usage
yarn formatstart:app
Runs the develop command, this mapping is needed so we can start both gatsby and lambda with one command (yarn start).
Usage
yarn start:appstart:lambda
Runs the netlify-lambda command, starts the lambda server in develop mode.
Usage
yarn start:lambdabuild:app
Builds the gatsby app
Usage
yarn build:appbuild:lambda
Runs the netlify-lambda build command, compiles the functions.
Usage
yarn build:lambdaLicense
By contributing to this project, you agree that your contributions will be licensed under its BSD 3-Clause license.