Update README (#37)

.github/workflows/node.js.yml

@@ -1,7 +1,7 @@
 # This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
 
-name: Flexwork front-end build
+name: CI
 
 on:
   push:

README.md

@@ -1,5 +1,72 @@
-# flexwork-app
+# Flexwork Client
 
 [![Build status](https://github.com/theflexwork/flexwork-frontend/actions/workflows/node.js.yml/badge.svg)](https://github.com/theflexwork/flexwork-frontend/actions/workflows/node.js.yml)
 
-Welcome to the Flexwork front-end, handling the requests for the Flexwork's users. We're working hard to prepare for the first public release. If you're seeing this message, the source code is still in development and not yet ready for production. For developer guidelines, please visit this [page](https://theflexwork.github.io/flexwork-docs/developer_guides/front_end)
+## Overview
+Flexwork Client is the front-end application for the Flexwork platform, designed to provide an intuitive and user-friendly interface for managing workflows, team collaboration, and requests. Built with Next.js, it offers a seamless experience across devices, leveraging modern web technologies for performance and accessibility.
+
+## Key Features
+
+1. Customizable Workflows: Allows users to create, edit, and visualize workflows with ease.
+
+2. Role-Based Access Control: Ensures secure and personalized access for users based on their roles.
+
+3. Optimized Performance: Built with Next.js for server-side rendering (SSR) and static site generation (SSG), ensuring fast load times and a smooth user experience.
+
+4. Integration with Flexwork Server: Communicates with the back-end via REST APIs for real-time data synchronization and updates.
+
+## Getting Started
+
+### Prerequisites
+
+* Node.js 20+
+* pnpm
+
+### Setup Instructions
+
+1. Clone the repository:
+
+```bash
+git clone [email protected]:theflexwork/flexwork-frontend.git
+cd flexwork-frontend
+```
+
+2. Install dependencies
+```bash
+pnpm install
+```
+
+3. Configure application parameters
+
+Set up the application environment variables by running the following script:
+
+```bash
+scripts/init_environments.sh
+```
+
+This script generates environment variables, including NEXT_PUBLIC_BACKEND_API, to establish the communication between the client and server. Example
+
+```
+NEXT_PUBLIC_API_BASE_URL=http://localhost:8080
+```
+
+4. Start the development server
+
+```bash
+pnpm dev
+```
+
+5. Access the application:
+Open your browser and navigate to http://localhost:3000.
+
+## Related Information
+- [Flexwork document](https://theflexwork.github.io/flexwork-docs): The centralized document for Flexwork products
+- [Flexwork Server](https://github.com/theflexwork/flexwork-server): Back-end services for Flexwork.
+- [Flexwork Client](https://github.com/theflexwork/flexwork-frontend): Front-end application.
+- [Flexwork Ops](https://github.com/theflexwork/flexwork-ops): Deployment and operational scripts.
+
+## Discussions
+For any inquiries about the project, including questions, proposals, or suggestions, please start a new discussion in the [Discussions](https://github.com/theflexwork/flexwork-frontend/discussions) section. This is the best place to engage with the community and the Flexwork team
+
+## License
+This project is licensed under the [AGPLv3](LICENSE) License.