LettuceMeetApp

This is the pre-release version of the Lettuce Meet Application.

LettuceMeetApp is an event management application that allows users to create and manage events, RSVP to events, and keep track of their own event attendance. This application is built with a Ruby on Rails API and a Vue.js frontend.

Local Installation

Before you can run the application, you must have Ruby, Ruby on Rails, PostgreSQL, Node.js, and VueJS installed on your machine.

Other tools that might help:

• Homebrew - for installing Ruby, Rails, Postgres, and Node.js
• Ruby Installer - installing Ruby on Windows
• RVM - ruby version manager
• Postico or Postgres.app - postgres clients

Once you have those installed, follow these steps:

1. Clone the repository from GitHub:

git clone https://github.com/Sun-Mountain/lettuceMeetApp
cd lettuceMeetApp

API

2. Install dependencies:

cd api
bundle install

You made need to make sure you have the correct version of Ruby installed. You can use RVM to install and switch versions.

rvm install 3.1.2
rvm use 3.1.2

3. Set up the database:

rails db:create db:migrate

4. Start the server:

rails s

The rails server will be running on localhost:3000 unless specified otherwise.

Frontend

In a separate terminal, make sure you have the Vue CLI installed:

yarn global add @vue/cli

5. Install dependencies:

cd lettuceMeetApp/frontend
yarn install

6. Start the frontend server:

yarn run dev

7. Open your browser and navigate to http://localhost:5173 to use the application.

Docker SetUp

Another option for installation and set up is to run our docker containers. To do so, navigate to the root folder in LettuceMeetApp and run:

docker compose build && docker compose up -d

Contributing

Read the full extent of our contributing in our CONTRIBUTING.MD file.

License

We use a GNU GENERAL PUBLIC LICENSE. Read the full extent of that license in the LICENSE.MD file.