Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. License
5. Contact

About The Project

What started off as just a quick boilerplate with a good folder structure is slowly growing into a starter kit that sets your React app off to a powerful start.

I hope you find it useful.

(back to top)

Getting Started

This stater kit uses Vite development environment to create a new React App. We will run through installing that first as a prerequisite and then move on to installing and running EXPACT.

Prerequisites

Remember to change "my-app" to whatever you want to name your app

1# npm 6.x
2npm create vite@latest my-app --template react
3
4# npm 7+, extra double-dash is needed:
5npm create vite@latest my-app -- --template react
6
7cd my-app
8npm install

Installation

1. Install EXPACT Boiler

1npm i @higherordermalfunction/expact

2. Run the package

1npx expact

3. Now run the server using Vite

1npm run dev

That's it.

(back to top)

Roadmap

• Setup basic directories
• Copy over main files
• Add ViteJS
• Add Tailwind CSS
• Add Base Server.js
• Add Database setup
• Add Login page
• Add Registration page
• Add Forgot Password page
• Add Reset Password page
• Add Dashboard page
• Add Profile page
• Add Settings page
  • Change Avatar
  • Change Name
  • Change Email
  • Change Password
  • Setup 2FA
  • Browser Sessions (List and Logout option)
• Basic API
  • Create API Token
  • Manage API Tokens (Permissions and Delete)
• Teams
  • Create Team
  • Invite Team Members
  • Manage Team Members

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the ISC License. See LICENSE.txt for more information.

(back to top)

Contact

DevByRich - @devByRich - higherordermalfunction@gmail.com

Project Link: https://github.com/higherordermalfunction/expact

(back to top)