From a8530d4fa86712e6424144abd6dd1ea28f62aac0 Mon Sep 17 00:00:00 2001 From: Niko Korvenlaita Date: Tue, 5 Apr 2022 13:30:58 +0300 Subject: [PATCH] Update README and gitignore --- .gitignore | 109 ++++------------------------------------------------- README.md | 43 ++++++++++++++++++++- 2 files changed, 49 insertions(+), 103 deletions(-) diff --git a/.gitignore b/.gitignore index 6704566..f93e15d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,104 +1,11 @@ -# Logs -logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* -lerna-debug.log* +node_modules -# Diagnostic reports (https://nodejs.org/api/report.html) -report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json - -# Runtime data -pids -*.pid -*.seed -*.pid.lock - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage -*.lcov - -# nyc test coverage -.nyc_output - -# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# Bower dependency directory (https://bower.io/) -bower_components - -# node-waf configuration -.lock-wscript - -# Compiled binary addons (https://nodejs.org/api/addons.html) -build/Release - -# Dependency directories -node_modules/ -jspm_packages/ - -# TypeScript v1 declaration files -typings/ - -# TypeScript cache -*.tsbuildinfo - -# Optional npm cache directory -.npm - -# Optional eslint cache -.eslintcache - -# Microbundle cache -.rpt2_cache/ -.rts2_cache_cjs/ -.rts2_cache_es/ -.rts2_cache_umd/ - -# Optional REPL history -.node_repl_history - -# Output of 'npm pack' -*.tgz - -# Yarn Integrity file -.yarn-integrity - -# dotenv environment variables file +/.cache +/functions/\[\[path\]\].js +/public/build .env -.env.test - -# parcel-bundler cache (https://parceljs.org/) -.cache - -# Next.js build output -.next - -# Nuxt.js build / generate output -.nuxt -dist - -# Gatsby files -.cache/ -# Comment in the public line in if your project uses Gatsby and *not* Next.js -# https://nextjs.org/blog/next-9-1#public-directory-support -# public - -# vuepress build output -.vuepress/dist - -# Serverless directories -.serverless/ - -# FuseBox cache -.fusebox/ - -# DynamoDB Local files -.dynamodb/ -# TernJS port file -.tern-port +# Supabase +**/supabase/.branches +**/supabase/.temp +supabase/config.toml diff --git a/README.md b/README.md index 6901ef9..854e24b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ -# base-b2b-app -Skeleton for B2B app +# Skeleton B2B app + +Building skeleton app for B2B context, basic features needed: +* authentication +* team management +* billing entity management +* access control +* event tracking to support Product Led Growth +* some dummy actions to fire those events + +Stack: +* [remix](https://remix.run) +* [supabase](https://supabase.com) +* [Cloudflare Pages](https://pages.cloudflare.com) + +I'll be streaming parts of the coding in [Twitch](https://www.twitch.tv/nipsuli) and the app will be used in in [This YouTube series](https://youtube.com/playlist?list=PLZRk_aw_oYVAhJUkC0Fk2gPC0096h0R8F) on building Minimum Viable PLG Setup. + +--- + +# Welcome to Remix! + +- [Remix Docs](https://remix.run/docs) + +## Development + +You will be utilizing Wrangler for local development to emulate the Cloudflare runtime. This is already wired up in your package.json as the `dev` script: + +```sh +# start the remix dev server and wrangler +npm run dev +``` + +Open up [http://127.0.0.1:8788](http://127.0.0.1:8788) and you should be ready to go! + +## Deployment + +Cloudflare Pages are currently only deployable through their Git provider integrations. + +If you don't already have an account, then [create a Cloudflare account here](https://dash.cloudflare.com/sign-up/pages) and after verifying your email address with Cloudflare, go to your dashboard and follow the [Cloudflare Pages deployment guide](https://developers.cloudflare.com/pages/framework-guides/deploy-anything). + +Configure the "Build command" should be set to `npm run build`, and the "Build output directory" should be set to `public`.