chrismclarke / sami-website

Overview

🚧 Under Development
This will be the repo to support the new SAMI website

Requirements

1. Node.js v14 or v16
2. yarn v2

Installation

1. Clone the application

git clone https://github.com/supportingami/sami-website

Checkout files stored with git large file system

git lfs checkout

2. Install necessary dependencies for the frontend application

yarn install

3. Create access token and admin user for the backend

yarn scripts strapi bootstrap

4. Start the backend and frontend

yarn start

This will run both backend and frontend serve scripts

Backend: http://localhost:1337/admin Frontend: http://localhost:3000

4. Authorize data

Any endpoints that are not publically accessible will not be available to the frontend unless a api token is generated and populated.

See instructions in docs/api-queries.md

Tech Stack

The system is built on top of NextJS, with a database backend and content management system powered by Strapi

If you are new to either project it is recommended to first familiarise yourself with the introduction and welcome tutorials for both packages

NextJS Introduction Strapi Introduction

Libraries

Additional technologies used within the frontend code

1. Chakra UI
2. Emotion
3. GraphQL
4. Apollo
5. NextAuth
6. TypeScript

Links and Resources

• https://nextjs.org/learn/foundations/about-nextjs
• https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html
• https://github.com/strapi/starters-and-templates/tree/main/packages/starters/next-blog
• https://www.apollographql.com/docs/react/get-started/

Adapted from nextjs-strapi-boilerplate