/Brevets

study project with the European database of industrial patents

Primary LanguageCSS

Project 3 - Piscope

PIScope

index

  1. Description
  2. Prerequisites
  3. [Getting Started](#Getting Started)
  4. [Technology Stack](#Technology Stack)
  5. Authors

Description

PIScope is an application linked to the European patent database: https://www.epo.org/searching-for-patents/data/web-services/ops_fr.html Its purpose is to allow the user to register his profile, to search for patents and to be able to keep his favorite ones and add comments to them.

Prerequisites

Getting Started

If you meet the prerequisites, you can proceed to the installation of the project by running the the following commands:
git clone https://github.com/WildCodeSchool/orleans-cda-sept2021-java-project-brevet
cd /orleans-cda-sept2021-java-project-brevet

I. To run the server, follow this steps:

1. Install Maven dependencies:

mvn install

2. Create the .env file

3. Add environment variables into .env file you created

To configure the application, you need to follow these steps to copy these variables below in order into your .env file and replace the variables’ values with your own personal information. You also have an exemple in the .env.model file . Comments are not recommended on this file. That might provoke some problems to run the application.

  • The list of variables for database

here you set you database informations

JDBC_DATABASE_URL=mysql://localhost/databaseName
DATABASE_USERNAME=mysql_user
DATABASE_PASSWORD=mysql-password
DATASOURCE_DRIVER_CLASS_NAME=com.mysql.jdbc.Driver
PORT=8080
JPA_HIBERNATE_DDL_AUTO=update
JPA_SHOW_SQL=true

you will need to go on API OPS site web for and sign up, to get the keys

CONSUMMER_KEY=your_consumer_key_for_api_call
CONSUMMER_SECRET_KEY=your_secret_key-for_api_call

  • The list of variables for JWT

you can choose a jwt secret key and expiration time

JWT_SECRET=choose_your_jwt-secret_key
JWT_EXPIRATION_MS=86400000

  • The list of variables for mail sending (should be replaced by your own email address)

The exemple here is for gmail you will need to change for your mail

MAIL_HOST=smtp.gmail.com
MAIL_PORT=587
MAIL_USERNAME=exemple@gmail.com
MAIL_PASSWORD=gmailPassword

  • The list of variables for password resetting

You can choose in how much time your password token stays valid (in minutes)

PASSWORD_RESER_TOKEN_EXPIRATION=1440

  • You need to find the path for file mailMessage.txt

PATH_FOR_MAIL_MESSAGE=./mailMessage.txt

  • The list of variables for front server

You can choose your front server and your port if you are in local you can use localhost and 4200

FRONT_SERVER_NAME=localhost
FRONT_SERVER_PORT=4200
AUTHORIZED_URLS=http://localhost:4200/

  • The list of variables URL for EPO and Espace Net URL

EPO_URL=http://ops.epo.org/3.2/rest-services/
PATENT_DATA_URL=published-data/publication/epodoc/
PATENT_SEARCH_URL=published-data/search/full-cycle
ESPACENET_URL=https://worldwide.espacenet.com/patent/search/family/

Note: On Windows: all variables must be inline separated by 1 space.

4. Import the last version of the dataVx.sql file into your database 5. To run the server of the application

  • On Linux: run the command sh ./env_spring_boot_run.sh
  • On Windows:
    open Git Bash Go to the root directory of the project orleans-cda-sept2021-java-project-brevet

Run the command: sh env_spring_boot_run.sh

II. To run the client, follow this steps:

1. Go into the client side folder by running the command:
cd angular/ 2. Install Angular dependencies:
npm install 3. Run server
ng serve

Technology Stack

Component Technology
Backend(REST) Spring boot 2 (Java)
Frontend Angular 13
Security JWT Authorization
Database MySQL
Persistance JPA
Server Build Tools Maven
Client Build Tools angular-cli, npm install

Authors