enrique-lozano / snackscan Goto Github PK

Welcome to the official repository of the most complete purchase management application in the market. In this repository you can collaborate with the project by helping us to complete translations or information about additives. You can also ask questions, make suggestions, report errors...

To report a bug, check the following link and create a new issue. Please, check before creating an issue that there are no similar ones in the list of open issues. If that were the case, follow the thread in question to stay up-to-date with news about that issue. For other aspects such as suggestions, doubts, etc. you can consult the forum of this repository.

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

The translations are in a json format here. To generate a new language you only have to create a new file lang.json where you must replace "lang" by the code of the language in question. You can extract these codes from this link looking at the ISO 639-1 Code column.

It is important that all new json files generated have exactly the same keys as the files already exposed. It is recommended to look at the en.json file for reference. You can also modify any existing translation file, if you consider that any translation can be improved.

Help with the additives information is very easy. You just need to open the file additives.ts of this project and do the changes that you consider necesary. Please, bear in mind that if you copy some literal content from internet you must add the source in the sources array. An example of an additive object is shown bellow:

  {
    "code": "E102",
    "description": {
      "es": "text-in-spanish....",
      "en": "This compound dissolves in water, turning more yellow as its amount increases in solution. It is commonly used in desserts, gum, gummies, energy drinks and snacks. <br> Many colorants of this family (not those authorized for food use) have been shown to be carcinogenic, although there is no evidence of this being so. However, there is evidence that this compound mixed with other additives can cause hyperactivity in minors"
    },
    "name": {
      "en": "Tartrazine",
      "es": "Tartrazina"
    },
    "toxicity": "High",
    "sources": [
      "McCann y col. (2007) 'Food additives and hyperactive behaviour in 3-year-old and 8/9-year-old children in the community: a randomised, double-blinded, placebo-controlled trial.' Lancet. 370(9598):1560-7."
    ]
  },

To add a new paragraph in the additive description, don't use \n or similar, use the <br> tag. If you add new languages in the previous section, you can also do it here, both for the name and description attributes. Remember that these new languages will always be optional attributes, the only mandatory language is English.

Enrique Lozano - [email protected]

Project Link: https://github.com/enriqueloz88/SnackScan