Skip to content

Commit 8e2ef98

Browse files
authored
Merge pull request #2 from Kroszborg/main
Initial Setup and Project Scaffolding
2 parents 2cafe71 + 5611100 commit 8e2ef98

22 files changed

+20377
-0
lines changed

README.md

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Time Capsule Website
2+
3+
Welcome to the **Time Capsule Website**! This application allows users to create and store their messages, which can be revealed at a future date. It offers a modern and intuitive interface with dark mode support, making it a perfect way to send messages to your future self or loved ones.
4+
5+
## Features
6+
7+
- **Create Time Capsules:** Users can create a time capsule by filling in their name, a message, and the reveal date.
8+
- **Dark Mode:** Toggle between dark and light mode for a comfortable viewing experience.
9+
- **Smooth Animations:** Enjoy a smooth user experience with various animations powered by Framer Motion.
10+
- **Responsive Design:** The application is designed to work seamlessly on various screen sizes.
11+
12+
## Tech Stack
13+
14+
- **Frontend:**
15+
- React
16+
- Tailwind CSS
17+
- Framer Motion
18+
- Lucide React (for icons)
19+
20+
- **Backend:**
21+
-
22+
-
23+
24+
## Getting Started
25+
26+
To get a local copy up and running, follow these steps:
27+
28+
### Prerequisites
29+
30+
Make sure you have the following installed on your machine:
31+
32+
- Node.js
33+
- npm (Node Package Manager)
34+
35+
### Installation
36+
37+
1. Clone the repository:
38+
39+
```bash
40+
git clone https://github.com/The-Red-Wood-Lab/Time-capsule-website.git
41+
42+
2. Navigate to the project directory:
43+
44+
```bash
45+
cd Time-capsule-website
46+
47+
3. Install the dependencies:
48+
49+
```bash
50+
npm install
51+
52+
4. Start the development server:
53+
54+
```bash
55+
npm start
56+
57+
5. Open your browser and visit http://localhost:3000 to view the application.
58+
59+
## Usage
60+
61+
1. Enter your name, message, and select a reveal date.
62+
2. Click "Send to Future" to create your time capsule.
63+
3. The confirmation message will appear upon successful submission.
64+
4. Use the "Cancel" button to reset the form.
65+
66+
## Contributing
67+
68+
Contributions are welcome! If you have suggestions for improvements or features, feel free to create an issue or submit a pull request.
69+
70+
1. Fork the project.
71+
2. Create your feature branch:
72+
73+
```bash
74+
git checkout -b feature/MyFeature
75+
76+
3. Commit your changes:
77+
78+
```bash
79+
git commit -m 'Add some feature'
80+
81+
4. Push to the branch:
82+
83+
```bash
84+
git push origin feature/MyFeature
85+
86+
5. Open a pull request.
87+
88+
## License
89+
90+
This project is licensed under the MIT License - see the LICENSE file for details.
91+
92+
## Acknowledgments
93+
94+
- Framer Motion for the animation library.
95+
- Tailwind CSS for the utility-first CSS framework.
96+
- Lucide React for the icon library.

frontend/.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*

frontend/README.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Getting Started with Create React App
2+
3+
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
4+
5+
## Available Scripts
6+
7+
In the project directory, you can run:
8+
9+
### `npm start`
10+
11+
Runs the app in the development mode.\
12+
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
13+
14+
The page will reload when you make changes.\
15+
You may also see any lint errors in the console.
16+
17+
### `npm test`
18+
19+
Launches the test runner in the interactive watch mode.\
20+
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
21+
22+
### `npm run build`
23+
24+
Builds the app for production to the `build` folder.\
25+
It correctly bundles React in production mode and optimizes the build for the best performance.
26+
27+
The build is minified and the filenames include the hashes.\
28+
Your app is ready to be deployed!
29+
30+
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
31+
32+
### `npm run eject`
33+
34+
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
35+
36+
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.
37+
38+
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.
39+
40+
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.
41+
42+
## Learn More
43+
44+
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45+
46+
To learn React, check out the [React documentation](https://reactjs.org/).
47+
48+
### Code Splitting
49+
50+
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
51+
52+
### Analyzing the Bundle Size
53+
54+
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
55+
56+
### Making a Progressive Web App
57+
58+
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
59+
60+
### Advanced Configuration
61+
62+
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
63+
64+
### Deployment
65+
66+
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
67+
68+
### `npm run build` fails to minify
69+
70+
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

0 commit comments

Comments
 (0)