-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create README.md for the React version
- Loading branch information
Showing
1 changed file
with
138 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
# Babyweeks | ||
|
||
Babyweeks is a React app designed to help users track their baby's development milestones by calculating the number of weeks since a given birthdate and providing relevant insights. The idea started back in 2022 using PyScript and transitioned to React in early 2025. The app is hosted on GitHub Pages. | ||
|
||
## Features | ||
|
||
- Input a birthdate to calculate the weeks since birth. | ||
- View developmental milestones content for specific week ranges. | ||
- Navigate through transitions using a simple and intuitive interface. | ||
|
||
--- | ||
|
||
## Installation and Setup | ||
|
||
Follow these steps to set up and run the app on your local machine: | ||
|
||
### Prerequisites | ||
|
||
- Node.js (16.x or later) and npm installed. | ||
|
||
### Clone the Repository | ||
|
||
```bash | ||
git clone https://github.com/ntemposd/babyweeks.git | ||
cd babyweeks | ||
``` | ||
|
||
### Install Dependencies | ||
|
||
Run the following command to install all required dependencies: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
### Start the Development Server | ||
|
||
To start the app in development mode: | ||
|
||
```bash | ||
npm start | ||
``` | ||
|
||
- Open your browser and navigate to `http://localhost:3000`. | ||
- The app will reload automatically as you make changes to the source code. | ||
|
||
--- | ||
|
||
## Deployment | ||
|
||
The app is automatically deployed to GitHub Pages from the `babyweeks-react` branch using GitHub Actions. | ||
|
||
### View the Live Application | ||
|
||
Visit the deployed app at: | ||
|
||
``` | ||
https://ntemposd.github.io/babyweeks | ||
``` | ||
|
||
### Manual Deployment | ||
|
||
If you need to deploy manually: | ||
|
||
1. Build the app: | ||
```bash | ||
npm run build | ||
``` | ||
2. Deploy to GitHub Pages: | ||
```bash | ||
npm run deploy | ||
``` | ||
|
||
--- | ||
|
||
## File Structure | ||
|
||
``` | ||
. | ||
├── public/ # Public assets | ||
├── src/ # Source code | ||
│ ├── App.js # Main application component | ||
│ ├── App.css # Global styles | ||
│ ├── assets/ # Images and JSON data | ||
│ ├── components/ # Reusable components (if applicable) | ||
├── .github/ # GitHub workflows | ||
│ ├── workflows/ | ||
│ ├── deploy.yml # Deployment configuration | ||
├── package.json # Project metadata and scripts | ||
``` | ||
|
||
--- | ||
|
||
## Technologies Used | ||
|
||
- **React**: Front-end framework. | ||
- **Bootstrap**: For responsive and modern styling. | ||
- **DatePicker**: Custom date input component. | ||
- **GitHub Pages**: Deployment platform. | ||
- **GitHub Actions**: CI/CD workflow for automatic deployment. | ||
|
||
--- | ||
|
||
## Contributing | ||
|
||
1. Fork the repository. | ||
2. Create a new branch: | ||
```bash | ||
git checkout -b feature-name | ||
``` | ||
3. Make your changes and commit them: | ||
```bash | ||
git commit -m "Add new feature" | ||
``` | ||
4. Push to the branch: | ||
```bash | ||
git push origin feature-name | ||
``` | ||
5. Open a pull request. | ||
|
||
--- | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License. See the LICENSE file for more details. | ||
|
||
--- | ||
|
||
## Troubleshooting | ||
|
||
If you encounter issues: | ||
|
||
- Ensure all dependencies are installed by running `npm install`. | ||
- Verify that your Node.js version is compatible with the app. | ||
- Check the browser console for error messages. | ||
- Reach out by opening an issue in the repository. | ||
|
||
|