Skip to content

Commit 1d25711

Browse files
Harshil-JaniHarshil-Jani
authored
Weekly Updates, Added Setup File and Created Blog Section (#66)
1 parent 8319912 commit 1d25711

5 files changed

Lines changed: 69 additions & 20 deletions

File tree

‎docs/2022/admin/setup.md‎

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,54 @@ title: Setup
55
<!--
66
77
-->
8+
### 1. Fork it :fork_and_knife:
9+
10+
You can get your own fork/copy of [admin-generator](https://github.com/Samagra-Development/generator-create-rc-admin) by using the <kbd><b>Fork</b></kbd> button.
11+
12+
### 2. Clone it :busts_in_silhouette:
13+
14+
You need to clone (download) it to a local machine using
15+
16+
```sh
17+
git clone https://github.com/Your_Username/generator-create-rc-admin.git
18+
```
19+
20+
> This makes a local copy of the repository in your machine.
21+
22+
Once you have cloned the `generator-create-rc-admin` repository in GitHub, move to that folder first using the change directory command.
23+
24+
```sh
25+
# This will change directory to a folder generator-create-rc-admin
26+
cd generator-create-rc-admin
27+
```
28+
29+
Move to this folder for all other commands.
30+
31+
### 3. Set it up :arrow_up:
32+
33+
Run the following commands to see that _your local copy_ has a reference to _your forked remote repository_ in GitHub :octocat:
34+
35+
```sh
36+
git remote -v
37+
origin https://github.com/Your_Username/generator-create-rc-admin.git (fetch)
38+
origin https://github.com/Your_Username/generator-create-rc-admin.git (push)
39+
```
40+
### 4. Run it :checkered_flag:
41+
42+
43+
- Install Yeoman globally `npm install -g yo`
44+
- Get required Node Modules `npm install`
45+
- Link it with Yeoman `npm link`
46+
- Go the any target directory where you want to create the admin.
47+
- Check if the generator has been added or not. `yo --generators` It must output the name of generator which is `create-rc-admin`
48+
49+
50+
### 5. For testing purpose 💥
51+
52+
- Go to your target directory where you want the admin files to be generated. `mkdir test` and `cd test`.
53+
- Now generate the files using the Yeoman generator for RC Admin. `yo create-rc-admin`.
54+
- Select if you have your REST or GraphQL APIs or want to continue with Sunbird-RC.
55+
- Give the title to your Dashboard which will hold that particular Entity.
56+
- Visit `localhost:3000` for viewing the site.
57+
- Try Performing the CRUD Operations from the Dashboard.
858

9-
"To be added"

‎docs/2022/admin/updates/2022-06-20.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ author: Harshil Jani
66
77
-->
88

9-
- [ ] Sunbird RC Setup locally
109
- [x] Play around with APIs
1110
- [x] Do a React Admin Data Provider Tutorial
1211
- [x] Setup Gitpod for Development Environment

‎docs/2022/admin/updates/2022-07-11.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ author: Harshil Jani
77
-->
88

99
- [x] End to end flow for creation of React Admin application using just Yeoman
10-
- [ ] Shell script to auto generate React Admin
11-
- [ ] Update Docker Compose to include React Admin
10+
- [ ] Shell script to auto generate React Admin `[Not Required]`
11+
- [ ] Update Docker Compose to include React Admin `[Not Required]`
1212
- [x] Add support for letting user choose API type and load equivalent DataProvider.

‎docs/2022/admin/updates/2022-07-18.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ author: Harshil Jani
88

99
- [x] Manage schema.json file in React Admin
1010
- [ ] Implement onUpdate => `docker-compose restart`
11-
- [ ] Auto Generate React Admin based on Sunbird-RC
11+
- [x] Auto Generate React Admin based on Sunbird-RC
12+
- [x] Document the Project

‎docs/2022/index.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,21 @@ C4GT has been conceptualized as a summer coding program to create a community th
1616
### Projects
1717
Following are the important links to projects done in C4GT - 2022.
1818

19-
| Student | Project |
20-
| :--- | :--- |
21-
| Akshay Sharma | [YAUS](/docs/2022/yaus) |
22-
| Ansh Sarkar | [Competency Passbook](/docs/2022/passbook) |
23-
| Arshpreet Singh | [UCI-Web-Channel](/docs/2022/uci) |
24-
| Deepdarshan | [Sunbirl QUML player](/docs/2022/sunbird-quml) |
25-
| Hardik Sharma | [Shiksha](/docs/2022/shiksha) |
26-
| Harshil Jani | [Admin for Sunbird RC](/docs/2022/admin) |
27-
| Himanshi Kukreja | [Sunbird QUML player](/docs/2022/sunbird-quml) |
28-
| Janhavi Lande | [Machine Learning](/docs/2022/ml-platform)|
29-
| Kanika Gola | [YAUS](/docs/2022/yaus) |
30-
| Kushboo Agarwal | [Centralized Access Control](/docs/2022/cac) |
31-
| Neelesh Sharma | [UCI-Web-Channel](/docs/2022/uci) |
32-
| Pratyaksh Singh | [Machine Learning](/docs/2022/ml-platform)|
33-
| Siddhant Tohan | [Shiksha](/docs/2022/shiksha) |
19+
| Student | Project | Blogs |
20+
| :--- | :--- | :-- |
21+
| Akshay Sharma | [YAUS](/docs/2022/yaus) | Link |
22+
| Ansh Sarkar | [Competency Passbook](/docs/2022/passbook) | Link |
23+
| Arshpreet Singh | [UCI-Web-Channel](/docs/2022/uci) | Link |
24+
| Deepdarshan | [Sunbirl QUML player](/docs/2022/sunbird-quml) | Link |
25+
| Hardik Sharma | [Shiksha](/docs/2022/shiksha) | Link |
26+
| Harshil Jani | [Admin for Sunbird RC](/docs/2022/admin) | [Independence in Indian Computing Field](https://medium.com/@harshiljani2002/independence-in-indian-computing-industry-ceb27fc047cb) |
27+
| Himanshi Kukreja | [Sunbird QUML player](/docs/2022/sunbird-quml) | Link |
28+
| Janhavi Lande | [Machine Learning](/docs/2022/ml-platform)| Link |
29+
| Kanika Gola | [YAUS](/docs/2022/yaus) | Link |
30+
| Kushboo Agarwal | [Centralized Access Control](/docs/2022/cac) | Link |
31+
| Neelesh Sharma | [UCI-Web-Channel](/docs/2022/uci) | Link |
32+
| Pratyaksh Singh | [Machine Learning](/docs/2022/ml-platform)| Link |
33+
| Siddhant Tohan | [Shiksha](/docs/2022/shiksha) | Link |
3434
### Mentors
3535

3636
* [Ashish Yadav](https://github.com/ashish-samagra)

0 commit comments

Comments
 (0)