einSelbst / einselbst-base-template

my basic tooling

Tooling

einSelbst Base Template

Basic Tooling for new repos.

Prerequisites

• homebrew
• fnm, a better nvm, to install node 18

brew install fnm
fnm install 18

• pnpm, a better npm

• fauna shell

brew install fauna-shell # or
pnpm i -g fauna-shell

• aws amplify console

pnpm i -g @aws-amplify/cli # for amplify deploys

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

API_KEY

ANOTHER_API_KEY

Installation

Install my-project with npm

pnpm install my-project
cd my-project

Run Locally

Install dependencies

pnpm install

Start the server

pnpm start

Development mode

pnpm dev

Open http://localhost:3000 with your browser to see the result.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Running Tests

To run tests, run the following command

pnpm test

Docker

The Application

Postgres

Fauna

pnpm fauna:local # open fauna shell connected to local docker fauna db

Deployment

To deploy this project run

pnpm deploy

Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

AWS

• Flightcontrol: [https://app.flightcontrol.dev/environments/clby72bd400u4mu014e4ab0nu](Flightcontrol Console) -> runs on cloudfront: [https://d3l3krwby7noux.cloudfront.net/](Cloudfront Deploy)

• Amplify: [https://eu-central-1.console.aws.amazon.com/amplify/home?region=eu-central-1#/dolgeptpazmtp](Amplify Console) -> [https://main.dolgeptpazmtp.amplifyapp.com/](Amplify Deploy)

Usage/Examples

import Component from 'my-project'

function App() {
  return <Component />
}

Documentation

Documentation

Screenshots

API Reference

Get all items

  GET /api/items

Parameter	Type	Description
api_key	string	Required. Your API key

Get item

  GET /api/items/${id}

Parameter	Type	Description
id	string	Required. Id of item to fetch

add(num1, num2)

Takes two numbers and returns the sum.

Color Reference

Color	Hex
Example Color	#0a192f
Example Color	#f8f8f8
Example Color	#00b48a
Example Color	#00d1a0

Tech Stack

Client: React, Redux, TailwindCSS

Server: Node, Express

Features

Examples

• Light/dark mode toggle
• Live previews
• Fullscreen mode
• Cross platform

Optimizations

What optimizations did you make in your code? E.g. refactors, performance improvements, accessibility

Lessons Learned

What did you learn while building this project? What challenges did you face and how did you overcome them?

Authors

• @einSelbst

Roadmap

• Turbo Monorepo
• Wundergraph
• react-hook-form
• fauna

Related

Here are some related projects

Overnext

Acknowledgements

• Awesome Readme Templates
• Awesome README
• How to write a Good readme

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.