Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
haianhng31 authored Jul 7, 2024
1 parent b72d473 commit f8bcf26
Showing 1 changed file with 23 additions and 11 deletions.
34 changes: 23 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,21 @@ By Hennessy (Hai-Anh) Nguyen, Nam Nguyen, Jenny (Trang) Do, Thanh Nguyen.

A place where you can slow down, connect deeper, and create a personalized meditation just for you.

<!--

## Table of Contents πŸ—ΊοΈ

- [Inspiration 🧠](https://github.com/jenneydo/PeacePod-Frontend#inspiration-)
- [Main Features & How to use πŸ‘](https://github.com/jenneydo/PeacePod-Frontend#how-to-use-book-hub-)
- [How we built it πŸ’ͺ](https://github.com/jenneydo/PeacePod-Frontend#how-we-built-it-)
- [Architecture πŸ™](https://github.com/jenneydo/PeacePod-Frontend#architecture-)
- [Accomplishments πŸ₯Ί](https://github.com/jenneydo/PeacePod-Frontend#accomplishments-that-were-proud-of-)
- [What we learned πŸ’‘](https://github.com/jenneydo/PeacePod-Frontend#what-we-learned-)
- [Next Steps 🀫](https://github.com/jenneydo/PeacePod-Frontend#whats-next-for-book-hub-)
- [Team πŸ§‘β€πŸ€β€πŸ§‘](https://github.com/jenneydo/PeacePod-Frontend#team-)
- [Contributors ✨](https://github.com/jenneydo/PeacePod-Frontend#contributors-)
-->
- [Inspiration 🧠](https://github.com/jennydo/PeacePod-Frontend?tab=readme-ov-file#inspiration-)
- [Main Features & How to use πŸ‘](https://github.com/jennydo/PeacePod-Frontend?tab=readme-ov-file#main-features--how-to-use-)
- [How we built it πŸ’ͺ](https://github.com/jennydo/PeacePod-Frontend?tab=readme-ov-file#how-we-built-it-)
<!-- - [Architecture πŸ™](https://github.com/jenneydo/PeacePod-Frontend#architecture-) -->
- Testing & GitHub Actions πŸ§ͺ
- [Challenges we ran into πŸ₯Ί](https://github.com/jennydo/PeacePod-Frontend?tab=readme-ov-file#challenges-we-ran-into-)
- [Accomplishments πŸ₯°](https://github.com/jennydo/PeacePod-Frontend?tab=readme-ov-file#accomplishments-that-were-proud-of-)
- [What we learned πŸ’‘](https://github.com/jennydo/PeacePod-Frontend?tab=readme-ov-file#what-we-learned-)
- [Next Steps 🀫](https://github.com/jennydo/PeacePod-Frontend?tab=readme-ov-file#whats-next-for-peacepod-)
- [Team πŸ§‘β€πŸ€β€πŸ§‘](https://github.com/jennydo/PeacePod-Frontend?tab=readme-ov-file#team-)
- [Contributors ✨](https://github.com/jennydo/PeacePod-Frontend?tab=readme-ov-file#contributors-)


## Inspiration 🧠

Expand Down Expand Up @@ -105,6 +107,15 @@ We are living in a state where there are numerous constant notifications, live f
- **Web Hosting**: AWS S3, EC3 (in progress)
- **Version Control**: Git & GitHub

<img width="957" alt="Screenshot 2024-07-07 at 4 45 30β€―PM" src="https://github.com/jennydo/PeacePod-Frontend/assets/126405175/ce9c7a55-e5a3-4e72-b9c2-5e1fe8611804">

## Testing & GitHub Actions πŸ§ͺ
* GitHub actions are on branch Main: Pull and push requests
* 2 running:
1. Run and check all unit tests
2. Run and check Eslint


<!-- ## Architecture πŸ™
We aim to have a highly modularized architecture, where every service has its own container and is independent from the others.
Expand Down Expand Up @@ -148,6 +159,7 @@ BookHub has 6 containers for 6 services:
- [ ] Implement add-on features for Chat (change theme icon, chat color...)
- [ ] Increase speed of socket.io
- [ ] Improve authentication (i.e implement Forget Password)
- [ ] Deploy it to EC2

### Contributing Guidelines πŸ› οΈ

Expand Down

0 comments on commit f8bcf26

Please sign in to comment.