Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrarvind90/fcc-american-british-translator
A full-stack translator web app for converting American English to British English. This application handles translations for time formats, titles, spellings, and unique words within each dialect.
https://github.com/mrarvind90/fcc-american-british-translator
chai chai-http cors css3 dotenv es6 eslint eslint-config-prettier express-validator expressjs freecodecamp freecodecamp-challenge freecodecamp-project freecodecamp-qa html5 javascript mocha nodejs prettier translation
Last synced: 17 days ago
JSON representation
A full-stack translator web app for converting American English to British English. This application handles translations for time formats, titles, spellings, and unique words within each dialect.
- Host: GitHub
- URL: https://github.com/mrarvind90/fcc-american-british-translator
- Owner: mrarvind90
- License: mit
- Created: 2023-09-26T09:44:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-27T16:12:55.000Z (about 1 year ago)
- Last Synced: 2024-10-16T22:14:16.249Z (2 months ago)
- Topics: chai, chai-http, cors, css3, dotenv, es6, eslint, eslint-config-prettier, express-validator, expressjs, freecodecamp, freecodecamp-challenge, freecodecamp-project, freecodecamp-qa, html5, javascript, mocha, nodejs, prettier, translation
- Language: JavaScript
- Homepage:
- Size: 106 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.freecodecamp.org/)
# American ⇆ British Translator
A full-stack translator web app for converting American English to British English. This application handles translations for time formats, titles, spellings, and unique words within each dialect.
## Technologies Used
- **Client Side:**
- HTML: Provides the structure of the web pages.
- CSS with Bootstrap: Adds styling and responsive design to the user interface.
- Vanilla JavaScript: Implements the client-side functionality for unit conversion.
- **Server Side:**
- Node.js: Provides the runtime environment for the server.
- Express.js: A web application framework for handling routes and requests on the server.
- **Testing:**
- Mocha: A testing framework for writing unit tests.
- Chai: An assertion library used in conjunction with Mocha for making test assertions.
## Features
- Conversion between British English to American English and vice versa
- Normalization of titles, spellings, and time units
- Translation of specific locale-specific words to their corresponding dialect
## Running the application
To run the express application, do follow the following steps
1. Clone the repo:
```git
git clone [email protected]:mrarvind90/fcc-american-british-translator.git
```
2. Navigate to the repository:
```shell
cd
```
Change to the name of the cloned directory.
3. Install Dependencies:
```shell
npm install
```
This command will install all the necessary dependencies for the application.
4. Configure Environment Variables: Rename the .env.sample file in your project directory to .env and update it with the
relevant credentials:
```shell
cp .env.example .env
```
5. Choose Your Run Mode:
- Development Mode (with automatic code reload):
To run the application in watch mode, enabling seamless source
code changes without manual server restarts, use the following command:
```shell
npm run dev
```
- Standard Server Mode:
If you prefer to simply run the server without automatic code reloading, you can use the
following command:
```shell
npm run start
```
6. Running the tests
- You can run unit tests for the application using Mocha and Chai. To run the tests, use the following command:
```bash
npm run test
```
## Future Improvements
While developing this project, there are several areas I plan to focus on for enhancements and refinements
which can be found on [GitHub](https://github.com/mrarvind90/fcc-american-british-translator/issues).