Skip to content

Commit

Permalink
docs: add project details
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronmcadam committed Aug 6, 2024
1 parent 77297f7 commit 5368d08
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 24 deletions.
35 changes: 11 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,23 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# MANUAL Quiz Landing Page Case Study

This project implements a landing page and quiz user flow.

![Screenshot](./docs/screenshot.png)

## Designs

The designs for the mobile and desktop experience are here: https://www.figma.com/design/JfC25Hjs0TfhrhW36kQpfA/MANUAL-Landing-Page?node-id=0-1&t=t61nmefRY10vysI8-1

## Getting Started

First, run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
## Testing

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
We use Playwright for end to end tests. To run the tests headlessly, run ```pnpm e2e```. To run them with a UI, run `pnpm e2e:ui`.
Binary file added docs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5368d08

Please sign in to comment.