Skip to content

Latest commit

 

History

History
98 lines (68 loc) · 3.35 KB

README.md

File metadata and controls

98 lines (68 loc) · 3.35 KB
Raw

Logo

Madre

Built with love & Next.js
https://madre.vercel.app

About The Project

Madre was our very first project, and the initial iteration is available https://oldmadre.vercel.app. Looking back over the years, we noticed a lot of issues and wanted to enhance our site, so we created this. As before, we welcome any and all suggestions and help.

Built With

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

  1. Clone the repo 
    git clone https://github.com/sahrohit/better-madre.git
  2. Install NPM packages 
    npm install
  3. Rename the env.example to env.local & update you enviroment variables. 
    API_KEY = YOUR API KEYS

After Setting Up

To initialize the frontend,

npm run dev - Starts a Next App at http://localhost:3000

Contributing

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.