Fotoverse

A Social Media Platform Inspired by Instagram
Explore the docs »

View Demo · 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

This project is the culmination of the 2024 Summer Internship Program at NUS Technology. As part of the internship, I am trained extensively in the role of a backend engineer, utilizing the Ruby on Rails framework to develop a feature-rich, Instagram-like social media web application. The project focuses on building a scalable and maintainable backend architecture, implementing robust APIs, and managing complex data models to support the application's functionalities.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

Ensure you have Ruby and Rails installed on your system. Detailed installation instructions can be found at the RVM website.

Installation

1. Clone the repo

   git clone https://github.com/pnv2003/fotoverse
   cd fotoverse

2. Configure the database

   Open the config/database.yml file in your project directory. Update the default settings with your database credentials. Here's an example configuration for a PostgreSQL database:

   default: &default
   adapter: postgresql
   encoding: unicode
   pool: 5
   username: <your-database-username>
   password: <your-database-password>
   host: <your-database-host>
   
   development:
   <<: *default
   database: <your-development-database>
   
   test:
   <<: *default
   database: <your-test-database>
   
   production:
   <<: *default
   database: <your-production-database>

3. Install dependencies

   bundle install

4. Initialize the database

   rails db:create db:migrate db:seed

5. Serve

   rails server

(back to top)

Usage

This section is under construction. In the meantime, feel free to explore the app!

(back to top)

Roadmap

• Add changelog
• Search content
• Lazy loading user content
• Multi-language support
  • English
  • Vietnamese
• SMTP mail server configuration
• Third-party authentication services integration
  • Google OAuth2
  • Facebook Login
  • Twitter OAuth 2.0
• Real-time notifications with WebSocket
• Deploy app to Render

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

This project is currently unlicensed. If you wish to use, modify, or distribute this code, please contact the author for permission. License terms may be added in the future, so please check back for updates.

(back to top)

Contact

Phuong Ngo - phuongngovan2003@gmail.com

Project Link: https://github.com/pnv2003/fotoverse

(back to top)

Acknowledgments

I would like to express my sincere gratitude to the following individuals and organizations for their support and contributions to this project:

• NUS Technology: For providing the opportunity to undertake this internship and for their continuous support and mentorship throughout the project.

• Mentors Nhan Nguyen, Kiet Nguyen, Tam Le, Tien Nguyen: For their invaluable guidance, insights, and encouragement during the development of this application.

• Ruby on Rails Community: For the extensive documentation and helpful resources that made learning and implementing the framework much easier.

(back to top)