This template is designed to easily showcase academic project and builds upon the F3RM Website. Project pages using this template are deployed at:
To start using this template in your own project, click on Use this template. This website is built using Gatsby.js and styled with Tailwind CSS. Follow these steps to get up and running:
- Install Node.js via the instructions here
- Install yarn with
npm install yarn - Install project dependencies with
yarn install - Start the development server with
yarn developand customize the website- The website will be available at http://localhost:8000/
- Customizations to the content in
src/pages/index.tsxshould now reflect in real-time - The color scheme can easily be adjusted in
src/components/ColorContext.ts
To build the website locally, run yarn build
To deploy the website to GitHub Pages, run one of the following commands:
yarn deploy-sshfor SSH-based authenticationyarn deployfor HTTPS-based authentication
Note
Before deploying, make sure to update the Git repository URL in package.json to point to your own repository if you're using this template for your project.
This project is licensed under the MIT License. For more details, see the LICENSE file.