Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/harukayamamoto0/locart

A powerful self-hosted image server!
https://github.com/harukayamamoto0/locart

free harukayamamoto0 image image-upload imgur locart manga nodejs open-source self-hosted server upload

Last synced: about 1 month ago
JSON representation

A powerful self-hosted image server!

Host: GitHub
URL: https://github.com/harukayamamoto0/locart
Owner: HarukaYamamoto0
License: apache-2.0
Created: 2024-04-28T02:13:58.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-05-20T13:37:02.000Z (8 months ago)
Last Synced: 2024-05-21T00:45:32.817Z (8 months ago)
Topics: free, harukayamamoto0, image, image-upload, imgur, locart, manga, nodejs, open-source, self-hosted, server, upload
Language: JavaScript
Homepage:
Size: 168 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]






  

    

  

  
Locart Server


  


    A powerful self-hosted image server!

    


    Explore the docs »

    


    


     Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    

      About The Project

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Usage

    Roadmap

    Contributing

    Acknowledgments

    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](https://github.com/nvm-sh/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

   ```sh

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

   ```

2. Install NPM packages

   ```sh

   npm install

   ```

3. Open the `locart.config.json` file, and fill in the necessary fields

4. After that, just start Locart using:

   ```sh

   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.

- [x] create the base

- [x] create a working version

- [x] configure the project (settings files)

- [x] create connection with the database

- [x] 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](https://github.com/HarukaYamamoto0/locart/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](https://github.com/othneildrew/Best-README-Template)

- [Rocketseat for the videos showing how to do it](https://youtu.be/MkkbUfcZUZM?si=0mV3_9I5Y_AN16rQ)

- [Flaticon by star logo](https://www.flaticon.com/br/icones-gratis/estrela)

(back to top)


## License

This project is under license. See the [LICENSE](./LICENSE) file for more details.

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/HarukaYamamoto0/locart.svg?style=for-the-badge

[contributors-url]: https://github.com/HarukaYamamoto0/locart/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/HarukaYamamoto0/locart.svg?style=for-the-badge

[forks-url]: https://github.com/HarukaYamamoto0/locart/network/members

[stars-shield]: https://img.shields.io/github/stars/HarukaYamamoto0/locart.svg?style=for-the-badge

[stars-url]: https://github.com/HarukaYamamoto0/locart/stargazers

[issues-shield]: https://img.shields.io/github/issues/HarukaYamamoto0/locart.svg?style=for-the-badge

[issues-url]: https://github.com/HarukaYamamoto0/locart/issues

[license-shield]: https://img.shields.io/github/license/HarukaYamamoto0/locart.svg?style=for-the-badge

[license-url]: https://github.com/HarukaYamamoto0/locart/blob/master/LICENSE.txt