oakif/arc-art-critique

ARC Art Critique

project_description
Explore the docs »

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

About The Project

ARC is a project focusing on providing an anonymousity-based platform for artists to make improvements. Artists can freely browse and comment on others' artwork posts, and they can post their own work to get constructive feedbacks and critiques. Arc exists with the mission to help an artist gather and give genuine critique anonymously from other artists in order to replenish creativity and create better art, and maintains the vision of creating a cordial place for all artists to achieve constant self-improvement.

(back to top)

Built With

• React.js
• Node.js
• MongoDB Atlas

(back to top)

Getting Started

Now let's get you ready to access ARC!

Prerequisites

You need to have the latest version of npm installed

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/AUSTlNC/arc-art-critique.git

2. Install NPM packages inside both backend and frontend folders

   cd arc-frontend
   npm install
   cd ../arc-backend
   npm install
   cd ../

3. Start frontend and backend servers

   First start the frontend server

   cd arc-frontend
   npm start

   Open up a new terminal window and cd into arc-art-critique directory then:

   cd arc-backend
   nodemon server.js

(back to top)

Usage

After installing, go to http://localhost:3000 to access ARC

(back to top)

Roadmap

• Login/Logout
  • Login with Google
  • Change password
  • Delete user
• Browse artwork posts in a gallery window
  • Apply artwork type filter
  • Search based on keyword(s)
  • Find all artworks commented
  • Find all artworks created by yourself
  • Get recommendations
• Comment on others' artwork posts anonymously
  • Comment spam filter
  • Delete comments
• Post your own artwork posts
  • Delete your own artwork posts
  • Review the comments from other users
• Report post feature

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

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

(back to top)

Contact

Austin Cai - @twitter_handle - [email protected]

Project Link: https://github.com/AUSTlNC/arc-art-critique

(back to top)