Skip to content

A social network showcase of digital art generated by AI

License

Notifications You must be signed in to change notification settings

yiremorlans/rendervous

Repository files navigation


rendervous logo

rendervous

Rendervous is a social network designed exclusively for the display and exploration of captivating digital art created by AI. Engage in lively discussions surrounding art by leaving comments and expressing appreciation through likes.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Optimizations
  6. Lessons Learned
  7. Contributing
  8. License
  9. Contact

About The Project

rendervous landing page

Rendervous is a social media platform for people who appreciate, enjoy, or create AI art. The artwork on rendervous is generated by artificial intelligence and includes a wide range of styles, from realistic to abstract. Share your creations in one place with friends and the rest of the world - without any restrictions. Whether you're an artist who wants to showcase their AI infused artwork to a global audience receive feedback, or a fan who simply wants to follow what's happening in this field, rendervous is a platform where everyone can participate.

Built With

NodeJS Express.js MongoDB

TailwindCSS DaisyUI EJS

(back to top)

Getting Started

To get the project running on your local machine, you will need Node.js and the following installation guide to get started.

Prerequisites

NPM

npm install npm@latest -g

Installation

  1. Sign up for your own non-relational document database at https://www.mongodb.com/
  2. Sign up for digital asset management at https://cloudinary.com/
  3. Clone the repo
    git clone https://github.com/yiremorlans/rendervous.git
  4. Install NPM packages
    npm install
  5. Enter your port, database string, and API keys in config.js or .env file
     PORT = 2121 (can be any port example: 3000)
     DB_STRING = `your database URI`
     CLOUD_NAME = `your cloudinary cloud name`
     API_KEY = `your cloudinary api key`
     API_SECRET = `your cloudinary api secret`
  6. Run in development environment || run the app on localhost:YOURPORT
    npm run dev
    npm start

(back to top)

Usage

profile page

create a post page

  • Sign up to get started.
  • Browse, like, and comment on the art within the community or upload your own AI creations
  • Popular AI art generators to explore :

(back to top)

Roadmap

  • Add like and delete feature to comments
  • Add notifications to new posts in the feed
  • Add friend feature
    • friend list featured at top of profile

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

(back to top)

Optimizations

Notifications for new comments left on user post is currently in development, as well as notifications to new posts by friends will be implemented in the near future as well. Planned future optimizations include ongoing improvements to the user interface and navigation. Users will be able to add friends to their profile, which will allow them to view all the posts specific to their friends.

Lessons Learned

I knew I wanted to incorporate an MVC structure to maintain organization during development but also to allow future improvements and features to be implemented post-production of rendervous. New features can easily be worked into a new or existing model (thanks mongoose), followed by logic and data retrieval within the controllers to then routing and paths be configured accordingly.

It was important to me to have a robust code base that would facilitate incorporating new features, but also modularity so that the views could be swapped out to integrate a different front-end library, like React. TailwindCSS + DaisyUI combination offered components and additional UI support I had envisioned for a clean aesthetic and user friendly experience as part of rendervous' core features.

A good portion involved using package libraries' respective documentation to troubleshoot issues encountered along the way, like method-override to send put requests through forms making rendervous a RESTful application.

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

License

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

Contact

Yire Morlans - @xenaaMorph

(back to top)

About

A social network showcase of digital art generated by AI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published