https://github.com/tusho7/friends_list_ruby
Friend List App is a Rails application for managing and interacting with a list of friends, featuring real-time updates, authentication, and efficient asset management.
https://github.com/tusho7/friends_list_ruby
bootsnap devise importmap-rails jbuilder puma ruby ruby-gem ruby-on-rails sprockets-rails sqlite3 stimulus-rails turbo turbo-rails tzinfo
Last synced: 3 months ago
JSON representation
Friend List App is a Rails application for managing and interacting with a list of friends, featuring real-time updates, authentication, and efficient asset management.
- Host: GitHub
- URL: https://github.com/tusho7/friends_list_ruby
- Owner: Tusho7
- Created: 2024-08-16T07:51:57.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T08:01:50.000Z (8 months ago)
- Last Synced: 2025-03-24T11:08:44.794Z (3 months ago)
- Topics: bootsnap, devise, importmap-rails, jbuilder, puma, ruby, ruby-gem, ruby-on-rails, sprockets-rails, sqlite3, stimulus-rails, turbo, turbo-rails, tzinfo
- Language: Ruby
- Homepage:
- Size: 133 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Friend List App
### Table of Contents
- [Prerequisites](#prerequisites)
- [Tech Stack](#Tecg-Stack)
- [Getting Started](#Getting-Started)
- [Project Structure](#Project-Structure)
- [Deployment](#Deployment)
#
### Prerequisites
- 
Ruby @ 3.3.4 and up
- 
Bundler @ 2.5.17 and up
- 
SQLite @ 1.4 and up (for development and testing)
#
### Tech Stack
- 
Rails @ 7.2.0 - A web application framework written in Ruby.
- 
Sprockets Rails - Asset pipeline for managing JavaScript and CSS.
- 
Puma @ 5.0 - A web server for Ruby/Rails applications.
- 
Importmap Rails - Manage JavaScript modules without a bundler.
- 
Turbo Rails - Speed up page loads with Turbo Drive and Frames.
- 
Stimulus Rails - JavaScript framework for adding interactivity.
- 
JBuilder - Build JSON responses in Rails.
- 
Devise @ 4.9 - Flexible authentication solution for Rails.
- 
TZInfo Data - Timezone data for Rails applications.
- 
Bootsnap - Speed up boot time of Ruby applications.
#
### Getting Started
1. First of all you need to clone app repository from Github :
```
git clone https://github.com/YourUsername/friend-list-app.git
```
2. Next step requires install the required gemss.
```
bundle install
```
3. Set up your database
```
rails db:create
rails db:migrate
```
4. Start the Rails server
```
rails server
```
#
### Project Structure
```
app
├── assets # Static assets (images, fonts, etc.)
├── channels # WebSocket channels for real-time features
├── controllers # Controllers for handling requests
├── helpers # Helper methods used in views
├── javascript # JavaScript and frontend assets
├── jobs # Background jobs for asynchronous processing
├── mailers # Mailers for sending emails
├── models # Models representing application data
├── views # Views for rendering HTML
bin
├── brakeman
├── bundle
├── bundle.cmd
├── docker-entrypoint
├── importmap
├── rails
├── rake
├── rubocop
├── setup
config
├── environments # Environment-specific configurations
├── initializers # Application configuration settings
├── locales # Translation files for internationalization
db
├── migrate # Database migration files
lib
├── tasks # Custom rake tasks
log # Application logs
public # Static files served by the server
test
├── fixtures # Test fixtures
└── system # System tests
Gemfile # Gem dependencies
Gemfile.lock # Locked gem versions
config.ru # Rack configuration file
Rakefile # Rake task definitions
README.md # Project documentation
```
###
This README template provides a clear structure and instructions for setting up and understanding your Frins List project. Adjust the sections and details according to your specific project setup and requirements.