weversonlemos/cepsearch-frontend repository overview

⁠cepsearch frontend

⁠About

Frontend developed to consume the cepsearch API⁠, which I developed to improve my knowledge in Java REST API's. React was used in this frontend, along with other technologies such as Docker, docker-compose and Redis in the backend, so that user requests are answered as quickly as possible.

⁠Requirements

1. Docker⁠
2. Docker-compose⁠

⁠Optional dependencies

1. Nodejs / npm⁠
2. Npx⁠

⁠Get Started

⁠Running the application with docker-compose

1. Clone the repository or download the source code

    git clone https://github.com/WeversonL/cepsearch-frontend.git
    cd cepsearch-frontend
   

   Copy

2. Start with docker-compose

    docker-compose up -d
   

   Copy

3. Open your browser and type in the URL bar

    http://localhost:3000/
   

   Copy

⁠Run using npm

Make sure you have Nodejs and NPM installed on your machine.

1. Clone the repository or download the source code

    git clone https://github.com/WeversonL/cepsearch-frontend.git
    cd cepsearch-frontend
   

   Copy

2. Download npm dependencies

    npm install
   

   Copy

3. Run the npm project

    npm start
   

   Copy

4. Open your browser and type in the URL bar

    http://localhost:3000/
   

   Copy

⁠Compile the project in a production-optimized manner, with performance optimizations with minifications

Make sure you have Nodejs, NPM and NPX installed on your machine.

1. Clone the repository or download the source code

    git clone https://github.com/WeversonL/cepsearch-frontend.git
    cd cepsearch-frontend
   

   Copy

2. Download npm dependencies

    npm ci
   

   Copy

3. Build project

    npm run build
    
   

   Copy

4. Install serve

    [⚠️ If you only want to use it locally and not install it globally, use: `npm install serve`]
    npm install -g serve 
   

   Copy

5. Run project

    npx serve build
   

   Copy

6. Open your browser and type in the URL bar

    http://localhost:3000/
   

   Copy

⚠️ Still in development

⁠License

cepsearch-frontend is released under the GNU General Public License, Version 2⁠

    Copyright (C) 2022 Weverson Lemos

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation; either version 2
    of the License, or (at your option) any later version