Skip to content

Latest commit

 

History

History
72 lines (42 loc) · 2.1 KB

README.md

File metadata and controls

72 lines (42 loc) · 2.1 KB

Session Token Website

Session Token Logo

Making Session possible.

Getting Started

This project is built with Next.js, Tailwind CSS, SCSS, Sanity, & Typescript.

System Requirements

Setup

  1. Install yarn
npm install yarn -g
  1. Install dependencies

Using --frozen-lockfile makes sure that the environment is consistent on any machine by installing the exact package versions listed in the yarn.lock.

yarn install --frozen-lockfile

Developing

Now you can run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the Session homepage.

You can start editing the page by modifying pages in the app/ directory. The page auto-updates as you edit the file.

The app/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Next.js

  • If you want to make a link to a location on the website use the next/link component with a relative path. i.e. https://token.getsession.org/updates -> /updates

Deploying to Production

You can run the project in a production environment by running:

yarn build:production && yarn start:production

This will build the site with the production configuration and start the server. Make sure to do this locally and check for errors before pushing any code changes to your hosted repository

Staging Environment

You can test the project in a staging environment by running:

yarn run build:staging && yarn run start:staging

This will build the site with the staging configuration and start the server.

License

Distributed under the GNU GPLv3 License. See LICENSE for more information.