Found in Translation -Find your tribe, lose the language barrier!
Found in Translation may well be the first online community that has overcome the language barrier, allowing its users to spark up conversations with anyone from all over the globe!
Gone are the days of having to use annoying plugin translators - Found in Translation does all the hard work for you behind the scenes, leaving you with more time to make connections!
Simply create an account and chose your language (over 160 to choose from). You can then create and read posts in your chosen language, regardless of what language they were originally written in! Theres a topic for everyone at Found in Translation!
View deployed site: Found in Translation
Found-In Translation is an online discussion board that aims to bridge individuals' language gaps. Its mission is to connect individuals from all over the world to discuss and share real-life experiences without any barriers.People of all ages are targeted by Found in Translation.
The user can easily search for a topic, language, or discussion to view its content and leave a comment; however, in order to add/edit a discussion, the user must login/register to the site. The site's goal is for users to be able to perform basic CRUD functionality (Create, Read, Update, and Delete) and interact with it intuitively while having a positive experience.
- As a first time user, I want to be able to easily navigate the site
- As a first time user, I want to be able to sign up to the site and create a profile
- As a first time user, I want to receive feedback that my profile has successfully been created
- As a returning/registered user, I want to be able to log in to my account
- As a returning/registered user, I want to be able to create a new post
- As a returning/registered user, I want to be able to flag offensive posts
- As a returning/registered user, I want to be able to view all Threads
- As a returning/registered user, I want to be able to reply to posts
- As an admin user, I want to be able to view flagged posts.
- As an admin user, I want to be able to delete messages that have been flagged that are offensive.
- As an admin user, I want to be able to unflag posts that are not offensive.
Found in Translation allows anyone to connect with others around the world with no language barrier. This means that the world is our target audience.
Colors have a significant effect on our mood, through them, we simulate a series of emotions. Our main objective in choosing our color theme was to transmit peace, happiness and harmony.
As the main focus of the site is the messages that people are sending, we have only used one font throughout the site to prevent users becoming overwhelmed.
Quicksand was imported from google fonts. It is a sans-serif font which is accessible friendly.
The entire site's wireframe was done using Figma.This depicts the site on a desktop and a mobile device.
MongoDB was chosen as the database for this project due to the flexibility it offers for non-relational data.
Diagram.io was used to create the data schema for this project. Our schema had three collections:
- Users
- Threads
- Posts
The site has been designed to be fully responsive, from mobile all the way up to desktop.
The site has a fully responsive navbar.
The site has a fully responsive footer. The footer contains links to social media, the privacy policy and terms and conditions pages. It also features a call to action button asking users to join now.
The Favicon was created using Favicon.io. We have chosen this image as our site logo and have also used it as our favicon as it brings brand cohesion to the site.
We have chosen this image as our site logo as we feel it displays the core principle of our site in an icon which allows the site logo to be understood by anyone, regardless of their language. The image shows a globe with two speech bubbles, each with a different language character.
We are aware that as we are asking users to create a username and a password to allow full interactivity with our site we need to also be mindful of how we are storing the data to ensure it remains private and secure. In the UK it is also important to be GDPR compliant.
As this site was created as part of a hackathon project, the privacy and terms & conditions pages have been created to demonstrate an understanding that we, as the site creators and custodians of peoples personal data have taken consideration about this and have provided the user with a terms and conditions and privacy policy page which lets the users know how their data is being used. These documents were created on RocketLawyer.com, a site that creates documents.
As the site has been created for educational purposes only, please note that the following documents would not be legally binding, they are purely to demonstrate an understanding of the topic. We would like to however ensure users that all measures have been taken to ensure any data entered into the site is secure.
To provide users with translated text on the pages, ISO 639-1 codes were used to classify the users’ language on the page. When a user signs up, they can choose a country to be their default language on their account. If a user replies to or starts a thread, the text posted will be translated.
We wanted to be able to display an icon for a language, however while researching we didn't feel that we could use country flags, as someone may speak a language, but not identify with the country flag for that language, as many areas can speak the same language. We eventually came across Language Icons by Anand Chowdhary which fit our thinking perfectly.
Translation API
Translation API Basic uses Google’s neural machine translation technology to instantly translate texts into more than one hundred languages. Translation API Advanced offers the same fast, dynamic results you get with Basic and additional customization features. Customization matters for domain- and context-specific terms or phrases, and formatted document translation.
Before you can start using the Cloud Translation API, you must have a project that has the Cloud Translation API enabled, and you must have a private key with the appropriate credentials. You can also install client libraries for common programming languages to help you make calls to the API. For more information, see the Setup page.
We created a class that takes two arguments, 'target' and 'text'. The target is the ISO 639 code of the language desired. The test is any text that we wish to translate. The two arguments are sent to the Google Translate API as a POST request. We hit Google's endpoint which returns a dictionary with the appropriate translated text.
If you wish to have further information about how we acheived the translation results, feel free to contact the team via Slack.
HTML, CSS, Javascript, Python, JQuery, Bootstrap, Heroku
- Figma - To create wireframes.
- Git - For version control.
- Github- To save and store the files for the website.
- Jinja - Templating engine
- Google Cloud Translate API - Controls the translation of the site into the chosen language. Please see ** section for more information on this API
- Bootstrap V5.2 - Used as CSS Framework
- Bootstrap Icons V1.8.2 - Used for the sites iconography
- Google DevTools - To troubleshoot and test features, solve issues with responsiveness and styling.
- Birme To compress images and convert to webP format.
- Favicon.io To create favicon.
- Am I Responsive? To show the website image on a range of devices.
- Shields.io To add badges to the README
- Heroku To deploy the project.
- Flask - Web Application Framework
- MongoDB - Non Relational Database
- Google fonts - used to import the font used on the site.
- TinyPNG - used to compress images in the readme
Please view our TESTING.md file for more information on the testing undertaken.
This project was deployed using Heroku:
- Create a new app with the name found-in-translation.
- Linked the found-in-translation app to its Github repository.
- Verify that the project has an up to date Procfile and requirements.txt
- Push the project to the Heroku remote.
- Set the SECRET_KEY environmental variable in the Heroku config vars.
- Set the IP to 0.0.0.0 and the PORT to 5000 in the Heroku config vars.
- Set the MONGO_URI environmental variable in the Heroku config vars.
- Restart all dynos.
- Open the app on Heroku and check to ensure that it's working correctly.
- Under the repository name on GitHub, click Clone or download.
- In the Clone with HTTPs section, click the icon beside the URL to copy the clone URL for the repository.
- Change the current working directory to the location where you want the cloned directory to be made.
- Type git clone, and then paste the URL you copied in Step 2.
- Press Enter. Your local clone will be created.
- Set up a virtual environment.
- Install the packages in requirements.txt by typing pip3 install -r requirements.txt in the CLI.
- Set the IP address to 127.0.0.1 and the PORT to 5000.
To fork the repository:
Log in (or sign up) to Github. Go to the repository for this project, Found in Translation Click the Fork button in the top right corner.
-
-
-
Logo and Favicon Image, sourced from Flatiron, created by Freepik
-
Avatars, sourced from specyboy
- Thank you to Code Institute and Soda Social for putting together this hackathon - we have had an amazing time taking part.
- A huge thank you to our families for once again putting up with us disappearing for another weeekend filled with hackathon fun.
"Thank you to Trust in Soda and Code Institute for giving me this wonderful opportunity to take part in Hackathon: May 22. The event was great fun, very helpful to me and the projects that all the teams produced were simply amazing! However, the best part of the past few days was working as part of team 'Gladiator' and making some AWESOME new friends!"
"I was looking forward to participating in a Soda/Code Institute Hackaton ever since I started my development course but did not have the courage to register until after I finished studying. This was a great experience with an amazing team. Everyone pushed themselves for this coding sprint to deliver a project that we can be proud of!"
"Participating in the May 2022 Hackathon organized by Trust in Soda in collaboration with Code Institute was an incredible experience. Thank you for this wonderful opportunity; the last few days have been simply incredible; I got to work with and learn from talented individuals, build my network skills, improve my collaborative skills, and have fun with my new friends while working on our exciting project. I'm looking forward to participating in many more hackathons in the future."
"Another whirlwind Hackathon weekend completed - spent creating an amazing site with some truly talented people! I love being able to take part in these events (Thanks Code Institute & Soda Social for putting this event together 😊), theres nothing better than being part of a community of people who are so generous with sharing their knowledge. Thanks Team Gladiator - you've been amazing!"
"Fantastic experience participating in my first Hackathon with Code Institute & Trust Soda. I had support from my entire Gladiator team and it was a great opportunity to gain more knowledge for my journey."