Code Monkey home page Code Monkey logo

arasaac-frontend's Introduction

Arasaac logo

Arasaac project



Made with ❤︎ by juanda and contributors

What is Arasaac

See website

Arasaac is a project that offers AAC symbols and resources to facilitate communication for those with some sort of problem in this area.

It's used worldwide by thousands of users.

Quick start

  1. Install requirements:
apt install libpng-dev apt install python-minimal
  1. Clone this repo using git clone https://github.com/juanda99/arasaac-frontend.git
  2. Run npm install to install dependencies
  3. Run npm start to see the app running at http://localhost:3000.*

Our backend server is dockerized, you can install it locally: see how to instal the backend server

Features and current status

  • Pictograms

    • Search pictograms
    • Pictogram editor
    • Favorites
  • Materials

    • Search materials
    • Material view
    • Upload materials (WIP)
  • Learn AAC

  • Online tools (WIP)

  • Spanish Sign Language

  • Developers

    • API docs
  • Users

    • User login
    • User profile
  • Terms of use

  • About us

Technical summary

React SPA based on React boilerplate
Using React, Redux, Immutable.js, Sagas and Reselect
API with nodeJS and Express on the server side
Swagger API framework for docs and MongoDB as database
Presentation
Material-ui
Data
MongoDB
Crowdin
For all the translations workflow
Authentication
JWT, user/password and social logins

Backend

Based on node.js and MongoDB, using Doocker and microservices. Show backend repo

License

This project is licensed under the MIT license, Copyright (c) 2016 . For more information see LICENSE.md.

Supporters

Gobierno de Aragón

European Union

arasaac-frontend's People

Contributors

dependabot[bot] avatar juanda99 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

arasaac-frontend's Issues

API notes

Hi everyone,

I develop a Wordpress plugin for a German public authority which allows to configure and download pictograms similar to your site. Therefore I had some fun with the API and thought I share my findings with you to improve this great project even further. If this is not the appropriate place, please move the issue or give me a hint. The following list is work in progress and not ordered or something. Just a few findings, or thoughts.

  • for easier API changes, a version would be great (e.g. /api/v1/)
  • in general the API documentation should include descriptions of every response field
  • /pictograms/{locale}/{idPictogram} is responding with non-translated keywords. If I use /pictograms/{idPictogram}/languages/{languages} I can see that there are translated keywords.
  • there is no documentation how I can use the endpoint /pictograms/{idPictogram}/languages/{languages} for multiple languages. I have to try it with the example.
  • /pictograms/{idPictogram} only allows to get a resolution of 500px or 2500px. With https://static.arasaac.org/pictograms/2340/2340_300.png I can also get images with 300px which is great for search results.
  • /pictograms/all/{locale} is a crazy endpoint, because it just takes too long and it's too much data. Some pagination would be great.
  • /pictograms/{locale}/search/{searchText} and /pictograms/{locale}/new/{numItems} (in general all search like endpoins) should have the same response structure. This would make development easier.
  • Maybe I don't know enough about the field, but what is the purpose of the schematic, sex, and violence field?
  • Is there any way to get the audio from arasaac.org? Would be great if this could be included in the API.
  • It would also be great if there would be a license or copyright/author field in the response, because this would ensure that we are always showing the correct license. Even if currently all pictograms are licensed the same, this could maybe change in the future.
  • All pictograms are looking like they are vector graphics, therefore it would be nice if svg's or something else could be exposed.

I hope that's not too much at once 😉


In case you are interested, what the WP plugin looks like (I will open another issue if the plugin is released):

image

I changed the organisation of the configuration options, since I believe related options should be grouped. With the great API it was also possible to hide all parameters which are not available.

image

Good job!

Hey,
👋 hello @juanda99 from belgium,
we know arasaac and araword for a few years now, because it runs on linux and is open source.
My Gf is a speach terapist and use your tools on a daily basis...
we discovered the new website 👍 good job...
and thanks

Wanted to let you know that make it available in french is really appreciated here and make it open too!
How can we help you build this (technically or not)?
do not hesitate to leave a few things in the issues i might pick something if i have some time available.

really nice project ❤️

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.