amanii-resources

amanii-resources is a community-driven hub dedicated to gathering and sharing mental health and mindfulness resources. Whether you're looking for guidance on well-being or want to share helpful tools, this platform provides an easy and accessible way to support the mental health journey for all.

The app targets Node.js 18.7.0
Link to the website can be found here: https://amanii-resources.netlify.app/

Table of Contents

1. Start Here
2. How to Set Up MongoDB
3. How to Set Up Node.js
4. Alternative (Docker) - Recommended for Fast Setup
5. Steps to Run Project (Without Docker)
6. Future Features
7. Contribution
8. License

Start Here

To use the app, you will need MongoDB, Node.js, and npm installed.

How to Set Up MongoDB

Install MongoDB on your machine.
Refer to the MongoDB Installation Guide for instructions based on your operating system.
After installation, start the mongod service in your command line.

How to Set Up Node.js

Install Node.js from nodejs.org by following the instructions for your operating system.

Installation of Node.js and npm on Different Operating Systems

Windows

Install using the link above and follow the instructions.

macOS

Install Node.js and npm using Homebrew. Open the terminal and run:

brew install node

Linux

Use apt to install nodejs and npm. In the terminal run:

    sudo apt update
    sudo apt install nodejs npm

Alternative (Docker) - recommended for a fast setup

Alternatively, you can set up Docker. If docker is not installed in your machine, follow the guide here docker guide.

This Docker configuration is specifically designed for running the application in a development environment. The setup includes development dependencies and other configurations optimized for local development.

Clone the project

    git clone https://github.com/Lonercode/amanii-resources.git
    cd amanii-resources

Remember to set up a .env.development file using the env example.

Run the command to start up and build the project:

    docker-compose up --build

Steps to run project (Without docker)

1. Clone the Repository

    git clone https://github.com/Lonercode/amanii-resources.git
    cd amanii-resources

2. Backend Setup

    cd server
    npm install

3. Frontend Setup

    cd ../client/amanii-resources
    npm install

4. Environment variables

Create a .env.development file using the .env.example file as a guide. Create your PORT and DB_URI env variables depending on your setup.

5. Start the Application

Start both backend and frontend servers. In each run:

    npm run dev

Future Features

• User Authentication: Implement user sign-up and login.
• Feedback System: Add a feedback/rating system so users can identify the most helpful resources.
• Mobile Responsiveness: Improve UI for better usability on mobile devices.
• Bookmarks: Allow users bookmark resources they find helpful for future reference.

Contribution

I welcome contributions to the amani-resources project. You can do so easily:

1. Fork the Repository

2. Clone Your Fork:

   git clone https://github.com/Lonercode/amanii-resources.git
   cd amanii-resources

3. Create your branch

    git checkout -b feature/YourFeatureName

4. Work on and commit your branch

   git commit -m "Hey Lonercode check out my contributions."

5. Push to your forked repo

   git push origin feature/YourFeatureName

6. Make a pull request

License

MIT - see the LICENSE file for details.