somulu / coding_challenge-28

Coding Challenge 28

Coding Challenge 28 | LANGO - The Complete Dev Language API 💻

As a community we are going to build an API! Lango aims to be the the complete development language API. A simple yet extensive HTTP API, providing its users with the ability to request both:

• Generalised data about their desired language, framework or standard.
• Specific language feature, for example: requesting information and examples on JavaScript Functions.

Motivation

The motivation behind this project is not only to provide a project that creates a learning opportunity in the technologies and stack used to create APIs and populating the data within the project, but also to become a final product that will be useful to developers and student alike when creating their applications/websites.

Code Style

We are using Prettier to create a uniformed code base that is easy to read for everyone. If you do not have Prettier set up in you editor, follow the advice set out this video, ensuring that you have the Format on save option enabled.

If you are using an editor other than Visual Studio code, do a quick google for your editor. If you are still stuck, ask for advice in our Discord!

Tech Stack

• Node
• Express
• Handlebars
• Jest

Features

• Lango should have beginner friendly documentation
• Lango should support for the various language in the programming and development world
• Lango should have a endpoint for searching general details and statistics for the requested language
• Lango should have a endpoint for looking up information and examples for the specified element of the language
• Lango should have a endpoint for requesting details about specified language standards, such as ECMASCRIPT

Getting Started / Installation

To get started with this project, be sure to check out the issues board here, to find a task. The pinned issues at the top of that page are generally considered on going and can have mutliple people working on them at same time. If you have any questions on getting started, ask in the #coding-challenge channel in discord

Installing and Setup

1. ❗ Fork this repo to your Github account
2. Clone your fork to you local machine
3. Open the project in your favourite code editor
4. Run npm install or yarn install

Tests

• Use npm test or yarn test to run the tests.

Tests breakdown.

1. framework.test.js - tests all the frameworks /json/frameworks/{framework_name}/{framework_name}.js
2. language.test.js - tests all the languages /json/languages/{language_name}/{language_name}.js

Resource for working with API's

1. Complete Web Developer course over at the ZTM Academy
2. Build A RESTful Api With Node.js And Express.Js Part One

Looking for more challenges?

We highly recommend checking out the back catalogue of coding challenges. With varying levels of complexity there is something to test and push every skill level.

One Last Thing!

Please note: As with all my challenges there is zero benefit or monetary gain I receive from it. This is just my way of thanking my students and making sure that you are able to continue gaining valuable knowledge outside of just my videos. It would mean a lot to me if you are able to rate my course...5 star reviews make my day :)