Skip to content

Commit

Permalink
adding instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Rizel Scarlett committed Aug 6, 2023
1 parent 1cb86c5 commit 8a566df
Showing 1 changed file with 20 additions and 28 deletions.
48 changes: 20 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,31 @@
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).
# Decentralized to do list
A to do list built with decentralized technologies

## Getting Started
## How to use
1. Go to https://blackgirlbytes.github.io/decentralized-to-do-list
2. Add a task
3. Once added, you can edit and update the task
4. You can also delete a task if no longer relevant

<img width="1460" alt="Screenshot 2023-08-06 at 3 56 12 PM" src="https://github.com/blackgirlbytes/decentralized-to-do-list/assets/22990146/52533ebc-d122-405a-a443-a11d001ad388">


## Running locally

First, run the development server:

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

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

You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.

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.
## Running in GitHub Codespaces
Click the button below, and the project will build and run in a GitHub Codespaces
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/blackgirlbytes/decentralized-to-do-list?devcontainer_path=/.devcontainer/basics/devcontainer.json)

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
# decentralized-to-do-list
## Technologies Used
- Next.js
- Web5 SDK
- Applitools
- Playwright

0 comments on commit 8a566df

Please sign in to comment.