Project Set up

Welcome to the x-admin-samarth wiki!

About 📖

• This project is an open-source, low-code framework to create internal admin tools for governance use cases.

Requirements 📜

1. Your machine should have Yarn or Npm

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

node -v
npm -v

Installation Steps 🚶

1. Fork it 🍴

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

2. Clone it 👥

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

git clone https://github.com/Samarth-HP/x-admin-samarth.git

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

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

cd x-admin-samarth

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/x-admin-samarth.git (fetch)
origin  https://github.com/Your_Username/x-admin-samarth.git (push)

4. Run the script

• Move to the portal folder
• To install Node modules, run the following command:

npm install
 or
yarn

and

npm run dev
 or
yarn run dev