komalioruganti/always

ALWays is a web-application built using javascript which helps girls maintain healthy menstrual cycles.

ALWays👩‍👧‍👦

A one stop destination for girls to educate themselves

Domain

  -Web Development

Tech Stack

  -Frontend using HTML5,CSS and Javascript
  -Backend using Nodejs and Expressjs
  -EJS for templating
  -Fetching data from mediastack API
  -Socket.io for chat feature
  -Bootstrap
  -JQuery
  -Inserting and Reading data from the Mongodb Database
  
  -Nodejs packages:
      "body-parser": "^1.20.1",
      "ejs": "^3.1.8",
      "express": "^4.18.2",
      "mongodb": "^4.12.1",
      "socket.io": "^4.5.4"

About this Project🤔:

ALWays is a web application to empower girls across the world. This app helps young girls to develop healthy period tracking habits. In this app, the user can also educate themselves reagrding various topics like period cramps, menstruation etc. It also enables them to contact other fellow girls and share their problems and experiences of various problems they had to face.

Features:

• ChatRoom : Using this feature one can join the chatroom and talk to all the active users. They can connect and chat with people from across the globe and ask for guidance regarding their problems. It could also be a great place to share experiences and make a few friends who have similar thoughts.
• Calendar : The calendar feature helps girls in tracking their menstrual cycles and understand what kind of changes their body is undergoing. One can store what they fell on a particular day and view them later on. This gives them the ability to analyse their health conditions and take up decisions to consult a doctor whenever required.
• Articles section : This feature gives the flexibility to view articles from various news sources without having to go through different websites and searches. It a;so gives the ability to find solutions to the queries you have.

Preview

Contributions

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

 -Fork and Clone the Project (https://github.com/komalioruganti/ALWays.git)
 -Create your Feature Branch (git checkout -b branch-name)
 -Commit your Changes (git commit -m 'commit-message')
 -Push to the Branch (git push origin branch-name)
 -Open a Pull Request

👉 Try it out. It's awesome

Steps to run it locally:

1. Clone the repository using git clone -https://github.com/komalioruganti/ALWays.git.
2. Enter to the project directory cd [local repository].
3. You'll need to get your own API Key from Mediastack API and update it in the articles.ejs file in the views folder.
4. You'll also need to get your own username and password the Mongodb Database(Atlas) and update it in the app.js file.
5. Install the dependencies using npm install.
6. Run the project npm start, the project should be running on http://localhost:3000 . Enjoy!!