|
2 | 2 |
|
3 | 3 | 
|
4 | 4 |
|
5 |
| -# Barcelona Developers Conference - DevBcn |
| 5 | +# DevBcn - Barcelona Developers Conference Website |
6 | 6 |
|
7 |
| -## Getting Started with Create React App |
| 7 | +## Project Overview |
8 | 8 |
|
9 |
| -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
| 9 | +This repository contains the official website for the Barcelona Developers |
| 10 | +Conference (DevBcn), a tech conference held in Barcelona, Spain. The website |
| 11 | +serves as the primary platform for conference information, including schedules, |
| 12 | +speaker profiles, talk details, venue information, and registration. |
10 | 13 |
|
11 |
| -### Available Scripts |
12 |
| - |
13 |
| -In the project directory, you can run: |
14 |
| - |
15 |
| -#### `npm start` |
| 14 | +## Technology Stack |
16 | 15 |
|
17 |
| -Runs the app in the development mode.\ |
18 |
| -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
| 16 | +- **Frontend Framework**: React 18 with TypeScript |
| 17 | +- **Routing**: React Router |
| 18 | +- **Data Fetching**: React Query and Axios |
| 19 | +- **Styling**: Styled Components and SASS |
| 20 | +- **UI Components**: PrimeReact, Swiper, Framer Motion |
| 21 | +- **Maps Integration**: Google Map React |
| 22 | +- **Testing**: Jest, React Testing Library |
| 23 | +- **Deployment**: GitHub Pages |
19 | 24 |
|
20 |
| -The page will reload if you make edits.\ |
21 |
| -You will also see any lint errors in the console. |
| 25 | +## Project Structure |
22 | 26 |
|
23 |
| -#### `npm test` |
| 27 | +The project follows a standard React application structure: |
24 | 28 |
|
25 |
| -Launches the test runner in the interactive watch mode.\ |
26 |
| -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
| 29 | +- `src/`: Source code |
| 30 | + - `assets/`: Static assets like images |
| 31 | + - `components/`: Reusable UI components |
| 32 | + - `hooks/`: Custom React hooks (e.g., useFetchSpeakers, useFetchTalks) |
| 33 | + - `views/`: Page components |
| 34 | + - `2024/`: Components specific to the 2024 conference edition |
| 35 | + - `2023/`: Components specific to the 2023 conference edition |
27 | 36 |
|
28 |
| -#### `npm run build` |
| 37 | +## Development Workflow |
29 | 38 |
|
30 |
| -Builds the app for production to the `build` folder.\ |
31 |
| -It correctly bundles React in production mode and optimizes the build for the best performance. |
| 39 | +### Getting Started |
32 | 40 |
|
33 |
| -The build is minified and the filenames include the hashes.\ |
34 |
| -Your app is ready to be deployed! |
| 41 | +1. Clone the repository |
| 42 | +2. Install dependencies with `npm install` |
| 43 | +3. Start the development server with `npm start` |
| 44 | +4. View the site at http://localhost:3000 |
35 | 45 |
|
36 |
| -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
37 |
| - |
38 |
| -#### `npm run eject` |
| 46 | +### Available Scripts |
39 | 47 |
|
40 |
| -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
| 48 | +- `npm start`: Run the development server |
| 49 | +- `npm test`: Run tests |
| 50 | +- `npm run test-coverage`: Run tests with coverage reporting |
| 51 | +- `npm run build`: Build for production |
| 52 | +- `npm run deploy`: Deploy to GitHub Pages |
| 53 | +- `npm run eject`: Eject from Create React App (not recommended) |
41 | 54 |
|
42 |
| -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
| 55 | +## Contribution Guidelines |
43 | 56 |
|
44 |
| -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. |
| 57 | +When contributing to this project, please: |
45 | 58 |
|
46 |
| -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. |
| 59 | +1. Follow the existing code style and patterns |
| 60 | +2. Write tests for new features |
| 61 | +3. Ensure all tests pass before submitting pull requests |
| 62 | +4. Keep the UI consistent with the existing design |
| 63 | +5. Document any new components or significant changes |
47 | 64 |
|
48 |
| -### Learn More |
| 65 | +## Contact |
49 | 66 |
|
50 |
| -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
| 67 | +For questions or issues related to the DevBcn website, please open an issue in |
| 68 | +this repository. |
51 | 69 |
|
52 |
| -To learn React, check out the [React documentation](https://reactjs.org/). |
| 70 | +Visit the live site at [https://www.devbcn.com](https://www.devbcn.com) |
0 commit comments