Locart Server

A powerful self-hosted image server!
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Acknowledgments
7. License

About The Project

Locart is an image upload server similar to imgur, but it differs because you can host Locart on your own machine, a good example of this is that I am creating it from a cell phone (this is not because I want to ), I am creating it from scratch because there are not many simple and reliable alternatives to creating your own upload server, I will strive to make this project grow and improve over time.

(back to top)

Getting Started

If you thought the project was cool, you've already given a star in the repository to help us, now below is the tutorial on how you can install Locart locally on your machine.

Prerequisites

First of all, you need to have the basic tools for developing in NodeJs, which are:

• Code editor (can be Visual Studio Code)
• Nodejs
• Git

  I strongly recommend you install the LTS version of nodejs using nvm, it is a version manager for nodejs, it makes installation easier and allows you to use different versions of nodejs

Installation

Now we will import the project to your local machine, and configure it

1. Clone the repo

   git clone https://github.com/HarukaYamamoto0/locart.git

2. Install NPM packages

   npm install

3. Open the locart.config.json file, and fill in the necessary fields
4. After that, just start Locart using:

   npm run start

(back to top)

Usage

🚧🧑‍💻 Under construction... 🧑‍💻🚧

(back to top)

Roadmap

The next commits will be more focused on the following tasks, but of course keep in mind that I won't necessarily go step by step.

• create the base
• create a working version
• configure the project (settings files)
• create connection with the database
• make a good file architecture
• create tests
• create authentication system
• improve operation to be able to upload many files
• create a client
• Create a demo for users to test
• Then I think about the rest

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 an incredible place to learn, inspire, and create. Any contribution you make will be greatly appreciated.

If you have a suggestion that could improve this, please fork the repository and create a pull request. Don't forget to give the project a star! Thank you again!

1. Fork the Project
2. Create your Feature Branch (git switch -c feature/AmazingFeature)
3. Commit your Changes (git commit)
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Acknowledgments

• Jpawlowski for the incredibly readme template
• Rocketseat for the videos showing how to do it
• Flaticon by star logo

(back to top)

License

This project is under license. See the LICENSE file for more details.

(back to top)