Skip to content

Latest commit

 

History

History
145 lines (91 loc) · 6.49 KB

README.md

File metadata and controls

145 lines (91 loc) · 6.49 KB
Raw

Lightning Kite React Starter

The purpose of this project is to be a starting point for new React apps that use Lightning Server as the backend. It is already set up with many packages and components that will be used in almost all projects including:

  • Authentication
  • Ability to switch which backend deployment is used from the login screen
  • Mock API for local development without running the backend
  • MUI UI component library including material icons
  • React Router with several example routes for reference
  • Formik for form state management with Yup for validation
  • Eslint, Prettier, and automatic import reordering

Documentation for included packages:

Using the Starter Project

This starter project can be run locally with node 16 by running npm install then npm start. To use it as a starter for a new project, fork this repo, then follow the steps below.

To avoid conflicting localStorage keys with other projects you're developing locally, you can change the prefix of the keys in src/utils/constants.ts to something unique to your project.

Node

This project is compatible with node version 16 (LTS).

NVM is recommended for easily manage installed node versions. Install nvm using this guide: https://github.com/nvm-sh/nvm.

nvm install 16
nvm use 16

Configure Environment Variables

Create a new .env file using the example. Errors will be logged to the console if the correct env variables do not exist.

REACT_APP_BACKEND_HTTP_URL is the default backend URL for the deployment. The actual backend URL being used can still be customized using the developer options on the login screen

REACT_APP_DEPLOYMENT_TYPE can be set to local, dev, staging, or production.

If you need to use different deployment type options, you will also need to update the options in src/utils/helpers/envHelpers.ts. This file also exports typed variables for all of the env variables so that they can be used safely in typescript.

cp ".env.example" ".env"
// .env

REACT_APP_BACKEND_HTTP_URL=mock

# Set to local, dev, staging, or production
REACT_APP_DEPLOYMENT_TYPE=local

// src/utils/helpers/envHelpers.ts

export enum DeploymentType {
  LOCAL = "local",
  DEV = "dev",
  STAGING = "staging",
  PRODUCTION = "production"
}

Lightning Server SDK & Mock Data

Generate an SDK your project's lightning server backend, then use it to replace the file src/api/sdk.ts.

There are 2 relevant files for using mock data located in the src/api directory: mockDatastore.ts and mockApi.ts.

The MockDatastore interface should contain all models provided by your app's backend through rest endpoints. For each of your apps models, create a function to generate mock data and put it in a file in the src/api/mocks directory. Use these function to generate a MockDatastore object in the generateMockDatastore function.

In mockApi.ts, the MockApi class should implement the Api interface from your SDK to provide mock data without making any calls to a server. The mockRestEndpointFunctions function from lightning-server-simplified will mock all of the standard rest endpoints for you.

// src/api/mockApi.ts

export class MockApi implements Api {
	...

	readonly user = {
		...mockRestEndpointFunctions<User>(this.mockDatastore.users, "user"),
		// Add any custom endpoints here
	}
}

To use the mock API, select the Mock server from the login screen.

Project Organization

All source code should be placed in the src directory. App.tsx contains the switch for rendering either the authenticated routes or unauthenticated routes depending on the auth state, and also provides react context to the app.

Most projects will benefit from using the following directory organization inside src:

/layouts

Layouts contain page structure that is common across many pages such as a header, footer, or navigation bar. Most apps will only have 2 layouts, one for authenticated pages and one for unauthenticated pages.

/routers

Router files provide routing to different pages using react router. Usually there will be one router for each layout.

/pages

Each file or directory in pages represents a "page" or "view" in the application. These pages are conditionally rendered by the routers. If all unique code for a page can reasonably be included in one file, then place a .tsx file directly in the pages directory. If the page is more complex and has several components (see for example the Login page), create a directory for that page with an index.ts file inside.

/components

Components in this directory are not specific to any one page, but can be reused across many different pages or layouts.

/styles

We have learned by sad experience that it is the nature and disposition of almost all developers, as soon as they get a little authority, as they suppose, they will immediately begin to write a bunch of convoluted, unmaintainable CSS.

Don't write CSS. Use MUI's styling system instead (see comments in theme.ts). If you need to add inline styles to a MUI component, use the sx prop. If you need to add styles to a non-MUI component, use the styles prop.

If you really really need to write CSS (for example to override styles from a third party component), there's a index.css file in this directory you can use.

/api

See the "Lightning Server SDK & Mock Data" section above. You shouldn't need to add any additional files to this directory besides what is mentioned in that section.

/utils

This is a catch-all directory for utility functions, models, hooks, helpers, or providers.

Deployment

Before deploying, remember to update the following app information in the public directory:

To create a production build, run npm run build.