1313## Run it locally
1414
1515Prerequisites: NodeJS must be installed on your machine.
16+
16171 . Clone this repo.
17182 . Run ` npm start ` command inside the root folder of the project.
18193 . To build the website, run ` npm run build ` .
@@ -21,36 +22,40 @@ Prerequisites: NodeJS must be installed on your machine.
2122## Adding/Updating content
2223
2324### How to add a bandhu
25+
24261 . Create a new branch.
25272 . Navigate to ` content/team ` folder.
26283 . Create a new folder with the bandhu's first name in lowercase. Include the last name if there's another bandhu with the same first name.
27294 . Create an index.md file inside the folder and the details like in the below template:
30+
2831```
2932---
30- name:
33+ name:
3134role:
32- description:
35+ description:
3336quote:
3437medium:
3538github:
36- twitter:
39+ twitter:
3740linkedin:
3841behance:
3942image: image.jpg
4043sectors: Sector 1, Sector 2
4144projects: Project 1, Project 2
4245---
4346```
47+
44485 . If the description has more than one paragraph, add it is raw text below the metadata of the ` index.md ` file.
49+
4550```
4651---
47- name:
52+ name:
4853role:
49- description:
54+ description:
5055quote:
5156medium:
5257github:
53- twitter:
58+ twitter:
5459linkedin:
5560behance:
5661image: image.jpg
@@ -62,15 +67,17 @@ Paragraph 1 of the bandhu's description.
6267
6368This is paragraph 2.
6469```
70+
65716 . Follow the same pattern for updating an existing bandhu's details.
66727 . Create a pull request when you are done.
6773
68-
6974### How to add a sector
75+
70761 . Create a new branch.
71772 . Navigate to ` content/work/ ` folder.
72783 . Create a new folder with the sector's name in lowercase and without spaces.
73794 . Create an ` index.md ` file inside the folder and add the details like in the below template:
80+
7481```
7582---
7683name:
@@ -95,15 +102,18 @@ events:
95102---
96103
97104```
105+
981065 . The sector's image must be inside the same folder and its name should match what's written in the ` index.md ` file's metadata.
991076 . To update an existing sector, simply edit the metadata of its ` index.md ` file.
1001087 . Create a pull request with your changes.
101109
102110### How to add a project
111+
1031121 . Create a new branch.
1041132 . Navigate to ` content/work/sectorone ` folder, where ` sectorone ` is the name of the sector to which the project belongs.
1051143 . Create a new folder with the project's name in lowercase and without spaces.
1061154 . Create an ` index.md ` file inside the folder and add the details like in the below template:
116+
107117```
108118---
109119name:
@@ -133,19 +143,27 @@ resources:
133143---
134144
135145```
146+
1361475 . The project's image must be inside the same folder and its name should match what's written in the ` index.md ` file's metadata.
1371486 . To update an existing project, simply edit the metadata of its ` index.md ` file.
1381497 . Create a pull request with your changes.
139150
140151### How to add a job opening
152+
1411531 . Create a new branch.
1421542 . Navigate to ` content/openings ` folder.
1431553 . Create a markdown file with its name as the title of the job in lowercase.
1441564 . Add a url where the job post is listed and the proper title of the job inside the markdown file created in the previous step.
157+
145158```
146159---
147160title: Front-end Engineer
148161url: https://angel.co/company/civicdatalab/jobs/1279092-front-end-engineer
149162---
150163```
164+
1511655 . Create a pull request with the changes.
166+
167+ ## License
168+
169+ The code is licensed under [ MIT License] ( https://mit-license.org/ ) while the contents inside the ` content ` folder are licensed under [ CC-BY-4.0] ( https://creativecommons.org/licenses/by/4.0/ ) .
0 commit comments