Admin Generator for Sunbird-RC

About 📖

An automatic Code Generator for X-ADMIN which makes the Admin Panel out of the Schemas present in Sunbird-RC and has the ability to perform CRUD Operation from the generated Dashboard itself.

Features 🎯

• Can connect to your custom APIs
• Have beautiful themes and widgets
• Run on any device, mobile or desktop, as long as it has a fairly modern browser
• Performs CRUD operations from the Dashboard itself
• Can be generated for multiple use cases.
• Provides No-Code solution to users who can update the Admin using Config files.
• Has ability to serve monorepo archietecture for set of Software services.

Use Case 🚀

• Quickly Generates the Admin for different sections of Governments like Educational Bodies, HeathCare sections etc.
• Generator can serve as a common automative tool for creating the Softwares within a working body.

Requirements 📜

1. Your machine should have Yarn or Npm.

2. Check the node and npm version by running following commands.

node -v
npm -v

Installation Steps 🚶

1. Fork it 🍴

You can get your own fork/copy of admin-generator by using the Fork button.

2. Clone it 👥

You need to clone (download) it to a local machine using

git clone https://github.com/Your_Username/generator-create-rc-admin.git

This makes a local copy of the repository in your machine.

Once you have cloned the generator-create-rc-admin repository in GitHub, move to that folder first using the change directory command.

# This will change directory to a folder generator-create-rc-admin
cd generator-create-rc-admin

Move to this folder for all other commands.

3. Set it up ⬆️

Run the following commands to see that your local copy has a reference to your forked remote repository in GitHub

git remote -v
origin  https://github.com/Your_Username/generator-create-rc-admin.git (fetch)
origin  https://github.com/Your_Username/generator-create-rc-admin.git (push)

4. Run it 🏁

• Install Yeoman globally npm install -g yo
• Get required Node Modules npm install
• Link it with Yeoman npm link
• Go the any target directory where you want to create the admin.
• Check if the generator has been added or not. yo --generators It must output the name of generator which is create-rc-admin

5. For testing purpose 💥

• Go to your target directory where you want the admin files to be generated. mkdir test and cd test.
• Now generate the files using the Yeoman generator for RC Admin. yo create-rc-admin.
• Select if you have your REST or GraphQL APIs or want to continue with Sunbird-RC.
• Give the title to your Dashboard which will hold that particular Entity.
• Visit localhost:3000 for viewing the site.
• Try Performing the CRUD Operations from the Dashboard.

Future Enhancements 🚀

• Allowing dataProviders being made out from a Config file.
• Make default set of variables for more faster generation.
• Have series of questions if user needs even more customizations.
• Use the Mock API server as the general purpose admin generator and make it more efficient.