Skip to content

Commit 4b09320

Browse files
authored
Update README.md
1 parent 2ef8df3 commit 4b09320

File tree

1 file changed

+60
-11
lines changed

1 file changed

+60
-11
lines changed

β€ŽREADME.md

Lines changed: 60 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -69,39 +69,88 @@ gatsby build
6969

7070
## Structure of code
7171

72-
73-
7472
```
7573
coderbunker
7674
β”œβ”€β”€ locales
77-
β”‚ β”œβ”€β”€ en
78-
β”‚ β”‚ └── translation.json // πŸ‘ˆ add EN string here
79-
β”‚ └── fr
80-
β”‚ └── translation.json // πŸ‘ˆ add FR string here
8175
β”œβ”€β”€ src
8276
β”‚ β”œβ”€β”€ assets
8377
β”‚ β”‚ β”œβ”€β”€ content
84-
β”‚ β”‚ β”‚ └── team.json // πŸ‘ˆ add team member info here
8578
β”‚ β”‚ β”œβ”€β”€ fonts
8679
β”‚ β”‚ β”œβ”€β”€ images
8780
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── team // πŸ‘ˆ add team member image here
88-
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ 001_ricky_ng_adam.jpg
89-
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── 002_etc...
9081
β”‚ β”‚ └── pdfs // πŸ‘ˆ add the Retainer Agreement here
9182
β”‚ β”œβ”€β”€ components
9283
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ button.js
93-
β”‚Β Β  β”‚Β Β  └── // reusable components, etc...
84+
β”‚Β Β  β”‚Β Β  └── // πŸ‘ˆ add reusable components, etc...
9485
β”‚Β Β  β”œβ”€β”€ pages
9586
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ 404.js
9687
β”‚Β Β  β”‚Β Β  └── index.js
9788
β”‚Β Β  β”œβ”€β”€ pdfs
9889
β”‚Β Β  β”‚Β Β  └── placeholder.pdf
9990
β”‚Β Β  └── styles
100-
└── gatsby-browser.js
91+
β”œβ”€β”€ gatsby-browser.js
92+
β”œβ”€β”€ gatsvy-config.js
93+
β”œβ”€β”€ gatsby-node.js
94+
β”œβ”€β”€ gatsby-ssr.js
95+
β”œβ”€β”€ postcss.config.js
96+
└── tailwind.config.js
10197
10298
```
10399

104100
## Team Content
105101

102+
#### Add a team member
103+
104+
1. Add an image in the `team` folder.
105+
106+
- Name the images following the format starting with `002`
107+
- it will be displayed as part of the stacked avatar and the team carousel if included in the team.json.
108+
109+
```
110+
β”œβ”€β”€ src
111+
β”œβ”€β”€ assets
112+
β”œβ”€β”€ content
113+
β”‚ └── team.json // πŸ‘ˆ add team member info here
114+
β”œβ”€β”€ images
115+
Β Β  Β Β  Β Β  └── team // πŸ‘ˆ add team member image here
116+
Β Β  Β Β  Β Β  β”œβ”€β”€ 001_ricky_ng_adam.jpg
117+
Β Β  Β Β  Β Β  └── 002_etc...
118+
```
119+
120+
2. Add a slide to the team carousel
121+
122+
```
123+
{
124+
"content": [
125+
{
126+
"name": "Ricky Ng-Adam",
127+
"title": "Founder, CoderBunker",
128+
"linkedin": "https://www.linkedin.com/in/rngadam/",
129+
"github": "https://github.com/rngadam",
130+
"image": "001_ricky_ng_adam.jpg", // πŸ‘ˆ reference the image in the `team` folder
131+
"highlights": [ // πŸ‘ˆ optimal length <= 7
132+
"25 years experience in software development",
133+
"Architecture, design, R&D",
134+
"Team recruitment, building and coaching",
135+
"Javascript, Python, C/C++, bash, plpgsql",
136+
"API: REST, Websockets, GraphQL",
137+
"Deployment (Linux, Ansible, Cloud, Docker)",
138+
"Database (PostgreSQL)"
139+
]
140+
},
141+
{ ...next member }
142+
]
143+
}
144+
```
106145

107146
## Translation
147+
148+
#### add/remove translation strings
149+
150+
```
151+
β”œβ”€β”€ locales
152+
β”œβ”€β”€ en
153+
β”‚ └── translation.json // πŸ‘ˆ add EN string here
154+
└── fr
155+
└── translation.json // πŸ‘ˆ add FR string here
156+
```

0 commit comments

Comments
Β (0)