https://github.com/edgedb/simpletodo

A preposterously simple todo app powered by EdgeDB
https://github.com/edgedb/simpletodo

Last synced: about 1 month ago
JSON representation

A preposterously simple todo app powered by EdgeDB

• Host: GitHub
• URL: https://github.com/edgedb/simpletodo
• Owner: edgedb
• Created: 2022-02-09T06:09:56.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-21T16:59:46.000Z (over 1 year ago)
• Last Synced: 2024-02-21T03:34:34.473Z (4 months ago)
• Language: TypeScript
• Size: 153 KB
• Stars: 6
• Watchers: 11
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-edgedb - EdgeDB TodoMVC - A classic todo application that is powered by EdgeDB. (Applications)

README

        
# TodoMVC with EdgeDB and Next.js

## The branches

- `main` — the completed version of the app

- `incomplete` — the incomplete version of the app

## Get started

- git clone

- TypeScript

- React

- Next.js

- [EdgeDB](https://edgedb.com/)

- The `edgedb` NPM module ([docs](https://www.edgedb.com/docs/clients/01_js/index/))

- [react-query](https://github.com/tannerlinsley/react-query) for fetching

- [Axios](https://github.com/axios/axios) for HTTP

### Clone the repo

```sh

$ git clone [email protected]:edgedb/simpletodo.git

$ cd simpletodo

$ yarn

```

### Initialize the project

Install the `edgedb` CLI if you haven't already

```bash

# macOS/Linux

$ curl https://sh.edgedb.com --proto '=https' -sSf1 | sh

# Windows

PS> iwr https://ps1.edgedb.com -useb | iex

```

Then initialize the project. Run the following command from the project root.

```bash

$ edgedb project init

```

This does a few things:

1. It installs EdgeDB if it isn't already installed on your computer.

2. It prompts you to create or select a local EdgeDB instance to be used for this project.

3. It automatically applies all migrations inside `dbschema/migrations`.

The database is now fully configured and ready for use!

### Generate TypeScript query builder files

Auto-generate the TypeScript query builder files based on the current schema:

```bash

$ npx @edgedb/generate edgeql-js

```

### Start the server

Start the server.

```bash

$ yarn dev

```

Then go to [localhost:3000](http://localhost:3000), and creating some todos, and start looking through the code to learn how to build applications with EdgeDB!