https://github.com/hoffmano/suricator-backend

🇺🇸 Platform for learning English through music.
https://github.com/hoffmano/suricator-backend

english english-learning heroku nlp nodejs python3 restful-api typescript

Last synced: 23 days ago
JSON representation

🇺🇸 Platform for learning English through music.

• Host: GitHub
• URL: https://github.com/hoffmano/suricator-backend
• Owner: Hoffmano
• Created: 2020-10-17T13:37:12.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-30T12:49:08.000Z (almost 4 years ago)
• Last Synced: 2023-03-07T17:44:27.900Z (almost 2 years ago)
• Topics: english, english-learning, heroku, nlp, nodejs, python3, restful-api, typescript
• Language: TypeScript
• Homepage: https://suricator.herokuapp.com
• Size: 268 KB
• Stars: 8
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  



Suricator - RESTful API




  

[![Status](https://img.shields.io/badge/status-active-success.svg)]()

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)




### 🗒️ Table of content

- [🖖 Presentation](#-presentation)

- [🔨 Installation](#-installation)

- [🔰 Routes](#-routes)

---

### 🖖 Presentation

This is the backend, of the Suricator system, a system that aims to use English through songs, with the main feature of classifying songs in levels through PLN (natural language processing).

---

### 🔨 Installation

1. Install dependencies: `yarn install` ou `npm install`;

2. Launch application: `yarn dev` ou `npm run dev`.

After configuration, just access the following address: [localhost:3333](http://localhost:3333)

---

### 🔰 Routes

That are the routes to use the API:

- GET: `/lyrics?search_string=your search go here`