Skip to content

touchlesscode/exo

main
Switch branches/tags
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

EXO

A blueprint for a more open, accessible, future-proof world.

πŸ™‰ What's this about?

EXO is the scaffolding required to make a more accessible world. It's comprised of a few key pieces:

  1. A universal data schema
  2. A lightweight smart loader to enable those with autism to use the web without frustration
  3. A bottomless ReactJS web shell which connects to headless systems and APIs

⚑ Roadmap

EXO is a collaboration of folks who care about making the world usable for people with autism. It turns out when we do that, the business metrics improve too. We're excited to have Gatsby, Rudderstack, Sanity and others involved in us building a true enterprise-grade, scalable and open-source framework we continually will improve.

Now:

  • EXO for Gatsby + Tailwind
  • Pre-alpha

Next:

  • RFC on the Touchless Schema spec for Person, Accomodation
  • EXO for Remix
  • EXO for NextJS
  • EXO for Svelte
  • Schema for Entity, Relationship, Location, Identity

How to Use

This project was generated using Nx.

πŸ”Ž Smart, Fast and Extensible Build System

Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are the core NX plugins:

  • React
    • npm install --save-dev @nrwl/react
  • Web (no framework frontends)
    • npm install --save-dev @nrwl/web
  • Angular
    • npm install --save-dev @nrwl/angular
  • Nest
    • npm install --save-dev @nrwl/nest
  • Express
    • npm install --save-dev @nrwl/express
  • Node
    • npm install --save-dev @nrwl/node

There are also many community plugins you could add.

Generate an application

Run nx g @nrwl/react:app gatsby to generate an application.

You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same workspace.

Generate a library

Run nx g @nrwl/react:lib my-lib to generate a library.

You can also use any of the plugins above to generate libraries as well.

Libraries are shareable across libraries and applications. They can be imported from @my-org/mylib.

Development server

Run nx serve gatsby for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run nx g @nrwl/react:component my-component --project=gatsby to generate a new component.

Build

Run nx build gatsby to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run nx test gatsby to execute the unit tests via Jest.

Run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests

Run nx e2e gatsby to execute the end-to-end tests via Cypress.

Run nx affected:e2e to execute the end-to-end tests affected by a change.

Understand your workspace

Run nx graph to see a diagram of the dependencies of your projects.

Further help

Visit the Nx Documentation to learn more.

To Deploy:

nvm use 16
yarn install
yarn run build

Storybook:

npx nx storybook shared-ui