Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacobheric/new-list
a new version of an old list app
https://github.com/jacobheric/new-list
apollo docker graphql parcel prisma react-hooks styled-components typescript
Last synced: about 2 months ago
JSON representation
a new version of an old list app
- Host: GitHub
- URL: https://github.com/jacobheric/new-list
- Owner: jacobheric
- Created: 2020-02-17T20:09:31.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T09:11:31.000Z (about 2 years ago)
- Last Synced: 2024-10-14T08:28:24.175Z (3 months ago)
- Topics: apollo, docker, graphql, parcel, prisma, react-hooks, styled-components, typescript
- Language: TypeScript
- Homepage:
- Size: 1.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A New List Application
-----------
A self hosted note/todo app built using Parcel, Node, Typescript, Apollo/Graphql,
React, Tailwind CSS and Prisma 2.
### pre-requisites
* `node`
* `yarn` or `npm`
### install dependencies
* `yarn` or `npm install`
### setup database
If you do not have a postgres db already, simply set these env vars in `.env`
```
DB_NAME=somedb
DB_USER=someuser
DB_PASSWORD=somepassword
```
and then run:
* `docker-compose up db`
Then set the connection url for the Prisma db toolkint in: `prisma/.env` like so:
`DATABASE_URL="postgresql://[someuser]:[somepassword]@[somehost]:[someport]/[someport]?schema=public"`
### bootstrapping Prisma
* `npx prisma generate`
* `npx prisma migrate save --experimental`
* `npx prisma migrate up --experimental`
This installs the Prisma smart node module, generates the db migrations and runs them against your db.
### running in dev mode
* `yarn` or `npm install`
* `yarn start` or `npm start`
* `yarn test` or `npm test`
### build and run in production mode
* `yarn build` or `npm run build`
* `node dist/index.js`
### docker (these require docker, obviously)
* `docker-compose up db` brings up a postgres db in a container (requires .env configs, see above).
* `docker-componse up app` brings the app up in a container.
* `docker-compose up` brings both the db and the app up in docker.
### more env vars
You can also change the port and the host the app runs on via .env or env vars. This is
necessary if you want the client to connect to a non-local server/api.
```
PORT=3000
HOST=0.0.0.0
```
### dark mode!
The app supports an optional dark mode
via [CSS prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
### roadmap/coming soon:
* ~~support for other db providers~~
* ~~production build support~~
* ~~run in docker~~
* ~~socket-based push updates~~
* ~~note search~~
* multiple note support
* authentication
* markdown support
* js-free support