Skip to content

Commit f6d7e99

Browse files
authored
Initialize the React Project (#18)
1 parent f2054b5 commit f6d7e99

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+17250
-1158
lines changed

.gitignore

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# production
12+
/build
13+
14+
# misc
15+
.DS_Store
16+
.env.local
17+
.env.development.local
18+
.env.test.local
19+
.env.production.local
20+
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*

CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
## Before Getting Started!
1010
Learn how to fork a repo, create an issue, make changes, create pull request.
1111

12+
Learn about the File structure we use [here](/FILE_STRUCTURE.md)
13+
1214
For more information, refer to <a href = "https://docs.github.com/en" target = "_self">GitHub Documentation</a>
1315

1416
--------

FILE_STRUCTURE.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# CSwala Website File Structure
2+
3+
```
4+
CSwala-website/
5+
|
6+
|- public # Contains the favicon, etc. Any files within this directory will not be processed by Webpack but copied directly to the build folder.
7+
|- src: # Contains all source code for the React application.
8+
|
9+
|- App.js
10+
|- index.scss
11+
|- index.js
12+
|- assets # Contains all the community brand assets. Keep all images, clips, etc here only
13+
|- components/ # Contains all the GLOBAL components used by "more than one" page. (includes Header, footer,etc.)
14+
|-fonts/ # Contains all the fonts
15+
|-pages/ # Contains all the sections of the page.
16+
| |-----Home /
17+
| | |- Home.jsx # has sections as components
18+
| | |- home.module.scss
19+
| | |- components/ # this components folder has components that is used by multiple sections of the same page (Home page)
20+
| | | |-component1Name/
21+
| | | | |- Component1Name.jsx (in PascalCase)
22+
| | | | |- component1-name.module.scss (in kebab-case)
23+
| | | |
24+
| | | |-component2Name/
25+
| | | |- Component2Name.jsx
26+
| | | |- component2-name.module.scss
27+
| | |
28+
| | |- sections/ # contains all sections of the page
29+
| | |
30+
| | |----Banner/ # section1 of the page
31+
| | | |- Banner.jsx
32+
| | | |- banner.module.scss
33+
| | |
34+
| | |
35+
| | |------Team/
36+
| | |- Team.jsx
37+
| | |- team.module.scss
38+
| | |- components/ # this components folder has components that is used by this section only
39+
| | |
40+
| | |-component1Name/
41+
| | |- Component1Name.jsx
42+
| | |- component1-name.module.scss
43+
| |
44+
| |
45+
| |
46+
| |- Contact us/
47+
| |- 404/
48+
|
49+
|
50+
|-seo/ # Contains code for meta tags using react-helmet
51+
52+
```

README.md

+1-12
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,7 @@
2525
🚀 Get Ahead with the right guidance from the Community.
2626

2727
## 🛠 Tech Used
28-
- HTML
29-
- CSS
30-
- Bootstrap
31-
- Javascript
32-
33-
[![forthebadge](https://forthebadge.com/images/badges/built-by-developers.svg)](https://forthebadge.com)
34-
[![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://forthebadge.com)
35-
[![forthebadge](https://forthebadge.com/images/badges/uses-html.svg)](https://forthebadge.com)
36-
[![forthebadge](https://forthebadge.com/images/badges/uses-css.svg)](https://forthebadge.com)
37-
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)
38-
39-
28+
- React
4029

4130
## Contribution Guidelines ⚙️
4231
You can find our Contributing guidelines [here](https://github.com/CSwala/CSwala-website/blob/main/CONTRIBUTING.md).

0 commit comments

Comments
 (0)