Skip to content

Auchendale/inkwell-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 

Repository files navigation

Inkwell App

This is a web app which allows users to send letters to each other as digital pen-pals, built with Next.js and written in TypeScript. See the demo video and meet the team here.

This web app is supported by a backend API - find the repo here and the hosted version here.

Due to the free service used to host the API, when first using the app and loading the users it may take a minute or so to retrieve the data; after this inital loading period using the app will be much faster.

Cloning this Repo

In order to clone this repo, navigate to your destination directory and run:

git clone https://github.com/Auchendale/inkwell-frontend

Then navigate to the inkwell directory within before installing the dependencies:

cd inkwell/

Installing Dependencies

In order to run this app you will require npm and certain dependencies. In your terminal run:

npm install

Host Locally

Start a local server with Next.js where you can try out the app:

npm run dev

Minimum Requirements

In order to run this app you need node version 22.2.0 or higher.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5