React-Typescript-webpack

Starter Park for react and typescript with Webpack 5

Summary

​

• Getting Started
• Runing the tests
• Deployment
• Versioning
• Repo Structure
• Authors
• License
• Acknowledgments ​

Getting Started

• clone the repo using git clone https://github.com/ibashir398/React-Typescript-webpack.git
• install the dependencies using npm install
• start the development server using npm run dev
• run tests using npm test

ScreenShot(s)

NIL

Dependencies

• Node v12.19.0
• Prettier
• Webpack v5
• React V17
• eslint
• babel
• Docker
• Typescript V4

Prerequisites

The following are required to run the app

• node v12

Setup

• clone the repo using git clone https://github.com/ibashir398/React-Typescript-webpack.git
• install the dependencies using npm install
• start the development server using npm run dev
• visit http://localhost:5001 on your browser and you will be presented with the login page ​

Running the tests [QA]

• To run the tests simply use npm test ​

Deployment [DevOps]

​ This section should describe how to deploy this on a live system. The details of Jenkins configuration for the repo should be stated ​ To deploy this app follow the steps below:

• Run npm build and a production optimized version of the app will be built
• Start the app using npm start.

A Dockerfile is also provided for container creation. `FROM node:12.13.1-alpine

RUN npm install webpack -g

WORKDIR /app COPY package.json . RUN npm install COPY . .

ENV NODE_ENV=production ENV PORT=5001

CMD ["npm", "start" ] EXPOSE 5001 ` ​

Versioning [Dev]

Version__________No Description of change___________Date

• N/A​ ​

Repo Structure

• N/A​

Authors [Dev]

• Ibrahim M Bashir
• Github Username: embashgit ​

License

​ This project is licensed under the GNU General Public License v3.0 License - see the LICENSE.md file for details ​

Acknowledgments