Merge pull request #4 from atlp-rwanda/ch-setup-readme-187584860

Ch setup readme file

README.md

@@ -1,5 +1,16 @@
-# e-commerce-ninjas-fe
-Front end repository for the teams' project
+# E-COMMERCE NINJAS WEB APPLICATION - FRONTEND
+
+Our e-commerce web application server, developed by Team Ninjas, facilitates smooth online shopping with features like user authentication, product cataloging, and secure payments. It's built to enhance the user experience with high performance and reliability. Suitable for any online marketplace looking to grow.
+
+
+## Hosted Application URL
+
+[https://e-commerce-ninja-fn-staging.netlify.app/](https://e-commerce-ninja-fn-staging.netlify.app/)
+
+## Github repository
+
+[https://github.com/atlp-rwanda/e-commerce-ninjas-fe](https://github.com/atlp-rwanda/e-commerce-ninjas-fe/tree/develop)
+
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/a7dce016f123cdcc9042/maintainability)](https://codeclimate.com/github/atlp-rwanda/e-commerce-ninjas-fe/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/a7dce016f123cdcc9042/test_coverage)](https://codeclimate.com/github/atlp-rwanda/e-commerce-ninjas-fe/test_coverage)
@@ -24,10 +35,30 @@ Front end repository for the teams' project
   ```bash
   npm run dev
   ```
+
+## StoryBook
 
+To run storybook for documentation, use this command
 
-## StoryBook
-To run storybook for documentation, use the command 
-```bash
-npm run storybook
+```sh 
+npm run storybook 
 ```
+
+## Folder Structure
+
+- `public`: Contains static files like `index.html` and images.
+- `src`: The main source folder for the React application.
+  - `components`: Reusable UI components.
+  - `pages`: Different pages/screens of the application.
+  - `store`: Redux store setup and slices.
+  - `stories`: StoryBook stories for UI components.
+  - `utils`: Utility functions and helpers.
+- `.babelrc`: Babel configuration file.
+- `.eslintrc`: ESLint configuration file.
+- `.gitignore`: Specifies which files and directories to ignore in Git.
+- `package-lock.json`: Automatically generated file that describes the exact tree of dependencies.
+- `package.json`: Contains project metadata and dependencies.
+- `README.md`: The readme file you are currently reading.
+- `tsconfig.json`: TypeScript configuration file.
+- `webpack.dev.config.ts`: Webpack configuration file for development.
+- `webpack.prod.config.ts`: Webpack configuration file for production.