Subscription-Based Online Directory for Wedding Service Providers

A platform that makes wedding planning easier by connecting you to vendors and guiding you through the planning process
Explore the docs »

View Test · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: ckekula, wedding-directory, twitter_handle, linkedin_username, email_client, email, project_title, project_description

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

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.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/ckekula/wedding-directory.git

2. Install NPM packages

   npm install

3. Navigate to the directory frontend

   cd frontend

4. Start the local Next.js server

   npm run dev

5. Open a new terminal and navigate to the backend directory

   cd backend

6. Install NPM packages for the backend

   npm install

7. Start the backend server locally

   npm run start

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

License

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

(back to top)

Contact

Hansika Karunathilake - LinkedIn
KRC Skekulawala - LinkedIn
Janitha Karunarathna - LinkedIn
Keshara Gunathilaka - LinkedIn

Project Link: https://github.com/ckekula/wedding-directory

(back to top)

Acknowledgments

We would like to express our gratitude to our client, Dr. Kushan Sudheera, for his guidance and support throughout the project.

(back to top)