JavaScriptCapstone

Table of Contents

• JavaScriptCapstone
• Table of Contents
• JavaScriptCapstone
  • Built With
    • Tech Stack
    • Key Features
  • Getting Started
    • Project Structure
    • Setup
    • Install
    • Usage
    • Run tests
  • Authors
  • Future Features
  • Contributing
  • Show your support
  • Acknowledgments
  • License

JavaScriptCapstone

This is the JavaScript Capstone project, where we built a web application based on an external API. The project is a webapp that revolves around a selected API, providing data about a topic of our choice. Here is the link to the video presentation

Built With

Tech Stack

Key Features

• Webpack Configuration
• HTML Generation
• CSS Styling
• Development Server
• Code Quality
• Modular Structure
• ES6 Syntax
• JavaScript Functionality
• Gitflow
• Send and receive data from API
• Jest testing
• API's

Getting Started

To get a local copy up and running, follow these steps. This project requires Node.js and npm installed on your machine.

-Node.js -npm

-Clone this repository to your local machine using:

git clone https://github.com/andream2429/JavaScriptCapstone.git

-Navigate to the project folder:

cd Leaderboard

-Install the project dependencies:

npm install

o start the development server, run the following command:

npm start

Project Structure

The project follows the following folder and file structure:

/src: Contains the source files of the application. /src/index.js: Main entry point of the JavaScript application. /src/style.css: CSS file for the application styles. /src/index.html: Base HTML file of the application. /dist: Contains the generated production files. webpack.config.js: Webpack configuration file.

Setup

Clone this repository to your desired folder: https://github.com/andream2429/JavaScriptCapstone.git

Install

Install this project with: install WebLint and ESLint

Usage

To run the project, execute the following command: just need a web Browser

Run tests

To run tests, run the following command: you just need a simple web browser to run this project for a test

Authors

Andrea Manuel

• GitHub: @AndreaM2429
• LinkedIn: LinkedIn

Claudia Rojas

• GitHub: @githubhandle
• LinkedIn: LinkedIn

Future Features

• [User Authentication]

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project show support by following this account

Acknowledgments

• Microverse for providing the opportunity to learn Git and GitHub in a collaborative environment.

• GitHub Docs for providing a wealth of information on Git and GitHub.

License

This project is MIT.