Sveltemeet

SvelteMeet

SvelteMeet is a straightforward CRUD-based website built in Svelte, providing users with a simple platform to create and manage meetup events.

📝 Table of Contents

• About
• Getting Started
• Deployment
• Built Using

🧐 About

SvelteMeet is a dynamic and user-friendly CRUD-based website designed to facilitate the creation, organization, and collaboration of meetup events.

The primary purpose of this project is to provide a seamless platform for users to easily create, manage, and engage in social events for various purposes.

Leveraging the power of Svelte, the web framework of choice, SvelteMeet ensures a smooth and interactive user experience, enabling event organizers and participants to efficiently connect and collaborate.

Whether users are planning casual get-togethers, professional networking events, or community meetups, SvelteMeet empowers them with an intuitive interface and robust functionality, making event coordination an enjoyable and streamlined process.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Before getting started with SvelteMeet, ensure that you have the following prerequisites installed on your system:

1. Node.js and npm: SvelteMeet relies on Node.js and npm for development. If not already installed, download and install them from Node.js official website.

2. Svelte: Svelte is the web framework used for building the frontend of SvelteMeet. Install it globally using the following command:

   npm install -g svelte
   

3. Editor (Optional): A code editor such as Visual Studio Code or Sublime Text is recommended for a smoother development experience. You can download Visual Studio Code from here if needed.

Installing

Follow these steps to set up a development environment and get SvelteMeet running on your local machine:

1. Clone the Repository:

   git clone https://github.com/Niravanaa/SvelteMeet.git
   

2. Navigate to Project Directory:

   cd SvelteMeet
   

3. Install Dependencies:

   npm install
   

4. Start the Development Server:

   npm run dev
   

5. Access the Application: Once the development server is running, open your web browser and go to http://localhost:5000 to access SvelteMeet.

6. Explore and Collaborate: You are now set up with a local development environment. Explore the features of SvelteMeet, create meetup events, and collaborate socially with other users.

🚀 Deployment

To deploy SvelteMeet on a live system, you can take advantage of the GitHub Pages deployment provided through the GitHub Actions workflow configured for this project. The deployment workflow is set up to automatically deploy the web app to the following link: https://niravanaa.github.io/SvelteMeet/.

Follow these steps to deploy SvelteMeet:

1. GitHub Pages Setup: Ensure that your repository is hosted on GitHub and navigate to the "Settings" tab. Scroll down to the "GitHub Pages" section, and under "Source," select the branch you want to deploy (usually "gh-pages").

2. Trigger GitHub Action: Push a commit to your main branch, and the GitHub Actions workflow will be triggered automatically. This workflow builds and deploys the SvelteMeet web app to the GitHub Pages link mentioned above.

3. Access the Deployed Application: Once the deployment is complete, you can access the live SvelteMeet application by visiting https://your-github-username.github.io/SvelteMeet/. Replace "your-github-username" with your actual GitHub username! Share this link with others to collaborate and participate in the meetup events.

⛏️ Built Using

• Svelte - Web Framework
• Node.js - Server Framework
• GitHub Pages - Deployment
• GitHub Actions - Continuous Integration/Continuous Deployment

✍️ Author

• @Niravanaa - Idea & Initial work