Acervo Digital

Acervo Digital is a image storage system to preserve the historical heritage of Paranaguá, you as a user can view the images and their stories, and as a moderator you can register them.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

Built With

• Adonis.js
• Bootstrap
• Bootstrap-Icons
• SASS
• Heroku

(back to top)

Getting Started

This is an example of how you can set up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• nodejs
• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/GustavoASCarvalho/Acervo.git

2. Install NPM packages

   npm install

3. Create database called "acervo"
4. Copy .env.example and set your envs

   DATABASE_URL=postgresql://postgres:123@localhost/acervo
   S3_KEY=YOUR_S3_KEY
   S3_SECRET=YOUR_S3_SECRET
   S3_BUCKET=YOUR_S3_BUCKET 
   S3_REGION=YOUT_S3_REGION 

5. Initialize your database and populate it

   node ace migration:run
   node ace db:seed

6. Run the project

   node ace serve

(back to top)

Roadmap

• Implementação do AdonisJS
• Implementação do Bootstrap
• Implementação do banco de dados Postgresql
• Models e migrations aplicados
• Autenticação adicionada
• Atribuição de relações
• Criação de um seeder paro banco de dados
• Estilização de paginas
• Adicionado validações de formulários
• Adicionado bibliotecas de segurança
• Atualizando relação de modelagem imagem/post para N pra N

(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.txt for more information.

(back to top)

Contact

Gustavo Alexandre da Silva Carvalho - Linkedin - [email protected]

Project Link: https://github.com/GustavoASCarvalho/Acervo

(back to top)

Acknowledgments

• Choose an Open Source License
• Repository README Template

(back to top)