Skip to content

Commit 1668db8

Browse files
committed
Updating README.md
1 parent a71b337 commit 1668db8

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# InnerSourcerers Map 🌍
2+
3+
An interactive globe visualization showing the geographical distribution of InnerSource Foundation members across the world. The application features a 3D globe with highlighted countries where members are located, along with a detailed side panel showing member information organized by country.
4+
5+
## Features
6+
7+
- 🌐 Interactive 3D globe visualization
8+
- 🎯 Country highlighting for member locations
9+
- 📋 Organized member list by country
10+
- 🔗 Social media links for members
11+
- 🖱️ Click-to-zoom country navigation
12+
- 📱 Responsive design
13+
14+
## Live Demo
15+
16+
Visit [https://innersourcecommons.github.io/innersourcerers-map/](https://innersourcecommons.github.io/innersourcerers-map/) to see the live application.
17+
18+
## Technology Stack
19+
20+
- Globe Visualization: [Globe.gl](https://globe.gl/)
21+
- Map Data: [World Atlas TopoJSON](https://github.com/topojson/world-atlas)
22+
- Member Data: YAML
23+
- Icons: [Font Awesome](https://fontawesome.com/)
24+
- Styling: Custom CSS
25+
26+
## Local Development
27+
28+
1. Clone the repository:
29+
```bash
30+
git clone https://github.com/InnerSourceCommons/innersourcerers-map.git
31+
cd innersourcerers-map
32+
```
33+
34+
2. Start a local server:
35+
```bash
36+
# Using Python 3
37+
python -m http.server 8000
38+
39+
# Using Python 2
40+
python -m SimpleHTTPServer 8000
41+
42+
# Using Node.js
43+
npx http-server
44+
```
45+
46+
3. Open your browser and navigate to `http://localhost:8000`
47+
48+
## Data Structure
49+
50+
Member data is stored in `data/members.yaml` with the following structure:
51+
52+
```yaml
53+
members:
54+
- name: "Member Name"
55+
role: "Role Title"
56+
area: "Country"
57+
linkedin: "LinkedIn URL" # Optional
58+
twitter: "Twitter URL" # Optional
59+
website: "Website URL" # Optional
60+
```
61+
62+
## Contributing
63+
64+
1. Fork the repository
65+
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
66+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
67+
4. Push to the branch (`git push origin feature/AmazingFeature`)
68+
5. Open a Pull Request
69+
70+
## License
71+
72+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
73+
74+
## Acknowledgments
75+
76+
- Thanks to all InnerSource Foundation members for their contributions
77+
- Globe.gl library for the amazing 3D globe visualization
78+
- World Atlas for providing the geographical data

0 commit comments

Comments
 (0)