|
| 1 | +# Meta Clock project using React, Spring and PostgreSQL |
| 2 | + |
| 3 | +**View on GitHub Pages:** https://zabrafax.github.io/spring-react-meta-clock/ |
| 4 | +*Note: The server may take a few minutes to start.* |
| 5 | + |
| 6 | + |
| 7 | +## Meta Clock allows you to display time in an interesting and elegant way. |
| 8 | + |
| 9 | +Inspired by [ *ClockClock 24* ](https://www.humanssince1982.com/en-eu/products/clockclock-24-white), |
| 10 | +created with React, Spring, Java and PostgreSQL. Web-application have different options to try. |
| 11 | +Once you find your perfect settings, you can display it on fullscreen. Have features like: |
| 12 | + |
| 13 | +* Ability to choose custom theme colors |
| 14 | +* Time zone selection |
| 15 | +* Different clock grid variations |
| 16 | +* Ability to create an account |
| 17 | +* All settings are saved on the server when you are logged in |
| 18 | +* Account sensitive data is saved in hashed form |
| 19 | +* Auto authorization using tokens |
| 20 | + |
| 21 | + |
| 22 | +## Deployment & Hosting |
| 23 | + |
| 24 | +* Backend deployed on Render |
| 25 | +* Frontend deployed automatically via GitHub Actions using Docker |
| 26 | +* Database hosted on Supabase |
| 27 | + |
| 28 | +### Note: |
| 29 | +Due to free hosting, the server may take a couple of minutes to start. |
| 30 | + |
| 31 | + |
| 32 | +## How to launch |
| 33 | + |
| 34 | +### View on GitHub Pages: |
| 35 | + |
| 36 | +https://zabrafax.github.io/spring-react-meta-clock/ |
| 37 | +*Note: The server may take a few minutes to start.* |
| 38 | + |
| 39 | +### Manual launch: |
| 40 | + |
| 41 | +1. Clone the repository: |
| 42 | + ```bash |
| 43 | + git clone git@github.com:Zabrafax/spring-react-meta-clock.git |
| 44 | + cd spring-react-meta-clock |
| 45 | + ``` |
| 46 | + |
| 47 | +2. Backend setup: |
| 48 | + ```bash |
| 49 | + cd backend |
| 50 | + ``` |
| 51 | + |
| 52 | + * Rename .env.example to .env: |
| 53 | + |
| 54 | + ```bash |
| 55 | + mv .env.example .env |
| 56 | + ``` |
| 57 | + |
| 58 | + * Edit .env and provide your database connection details: |
| 59 | + |
| 60 | + ```ini |
| 61 | + SPRING_DATASOURCE_URL=jdbc:postgresql://localhost:5432/meta_clock_db |
| 62 | + SPRING_DATASOURCE_USERNAME=postgres |
| 63 | + SPRING_DATASOURCE_PASSWORD=postgres |
| 64 | + ``` |
| 65 | + |
| 66 | + * Create the database meta_clock_db in PostgreSQL: |
| 67 | + |
| 68 | + ```sql |
| 69 | + CREATE DATABASE meta_clock_db; |
| 70 | + ``` |
| 71 | + |
| 72 | + * Run the backend (Spring Boot): |
| 73 | + |
| 74 | + ```bash |
| 75 | + ./mvnw spring-boot:run |
| 76 | + ``` |
| 77 | + |
| 78 | +3. Frontend setup: |
| 79 | + ```bash |
| 80 | + cd frontend |
| 81 | + ``` |
| 82 | + |
| 83 | + * Rename .env.example to .env: |
| 84 | + |
| 85 | + ```bash |
| 86 | + mv .env.example .env |
| 87 | + ``` |
| 88 | + |
| 89 | + * Install dependencies: |
| 90 | + |
| 91 | + ```bash |
| 92 | + npm install |
| 93 | + ``` |
| 94 | + |
| 95 | + * Start the React app: |
| 96 | + |
| 97 | + ```bash |
| 98 | + npm start |
| 99 | + ``` |
| 100 | + |
| 101 | + |
| 102 | +## Technologies Used |
| 103 | + |
| 104 | +*  |
| 105 | +  |
| 106 | +  |
| 107 | +  |
| 108 | +  |
| 109 | +  |
| 110 | +*  |
| 111 | +  |
| 112 | +  |
| 113 | +  |
| 114 | +  |
| 115 | +*  |
| 116 | +  |
| 117 | +  |
| 118 | + |
| 119 | + |
| 120 | +## Future Improvements |
| 121 | + |
| 122 | +Adding different animations. |
| 123 | + |
| 124 | +#### Created by [@Zabrafax](https://github.com/Zabrafax) |
0 commit comments