Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bm-mit/prisee-fe
Front-end for PRISEE website
https://github.com/bm-mit/prisee-fe
Last synced: 13 days ago
JSON representation
Front-end for PRISEE website
- Host: GitHub
- URL: https://github.com/bm-mit/prisee-fe
- Owner: bm-mit
- Created: 2024-03-25T13:54:34.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-31T15:14:32.000Z (9 months ago)
- Last Synced: 2024-07-17T10:53:25.098Z (5 months ago)
- Language: JavaScript
- Size: 3.93 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PRISEE - Frontend
## Getting started
- Install dependencies.
```bash
npm install
```
- Build the project.
```bash
npm run build
```
- Preview the production build.
```bash
npm run preview
```
- Deploy to Firebase.
```bash
firebase deploy
```
## Naming conventions
- Use PascalCase for components and component's filenames. (`PrimaryButton`, `Button.js`)
- Use camelCase for variables, function names, folder names and non component
file names. (`const myVariable = 'hello'`, `components/`, `jsonParser.js`)
## Folder Structure
```text
my-react-app/
│
├── public/ (Public assets)
│ ├── index.html
│ └── favicon.ico
│
├── src/
│ ├── assets/
│ │ ├── images/
│ │ └── styles/
│ │ ├── components/ (Component-specific styles)
│ │ └── main.scss (Main styles)
│ │
│ ├── components/ (Reusable UI components)
│ │ ├── Button/
│ │ ├── Header/
│ │ └── ...
│ │
│ ├── pages/ (Top-level page components)
│ │ ├── Home/
│ │ ├── About/
│ │ └── ...
│ │
│ ├── services/ (API services, utilities)
│ │ ├── api.js
│ │ └── ...
│ │
│ ├── context/ (React context providers)
│ │ ├── AuthContext.js
│ │ └── ...
│ │
│ ├── hooks/ (Custom hooks)
│ │ ├── useFetch.js
│ │ └── ...
│ │
│ ├── utils/ (Helper functions)
│ │ ├── formatDate.js
│ │ └── ...
│ │
│ ├── App.js (Main component)
│ ├── index.js (Entry point)
│ └── ...
│
├── .gitignore
├── package.json
├── README.md
└── ...
```