Merge pull request #8 from liqwik/dev

docs: update README.md

README.md

@@ -1,13 +1,54 @@
-🌟 Welcome to the Mini Linked! 🌟
+# Mini Linked: Mini App for Job Seekers
 
-Are you looking to take the next step in your career? You're in the right place! Our powerful job search platform is designed to connect talented individuals like you with exciting career opportunities.
+[@MiniLinkedBot](https://t.me/MiniLinkedBot) - is a Telegram Mini App that providing the global job search and connecting talented individuals with exciting career opportunities.
 
-With our user-friendly interface and comprehensive database of job listings, you can easily browse through a wide range of industries, professions, and locations. Whether you're a seasoned professional or just starting your career journey, we've got you covered.
+## Tech Stack
 
-Discover job openings from top companies and organizations, explore detailed job descriptions, and apply directly through our app. We'll help you streamline your job search and make the process as smooth as possible.
+- **Frontent** NextJS, TailwindCSS
+- **Backend** KoaJS
 
-Stay up-to-date with the latest job market trends, industry insights, and expert career advice through our curated resources. We're here to empower you with the knowledge and tools you need to succeed in your job search.
+## Requirements
 
-Remember, your dream job is just a few clicks away. Let's embark on this journey together and unlock endless career possibilities. Good luck!
+- Telegram Bot
+- NodeJS (Latest LTS version recommended)
 
-If you have any questions or need assistance, feel free to reach out to our support team. Happy job hunting! 🎉"
+## Start the application
+
+### Frontend
+
+```
+$ cd frontend
+$ yarn install
+$ cp .env.example .env
+```
+
+> Replace the Job Listing API, or use this endpoint https://mnl-api.quiclabs.com for testing
+
+```
+$ yarn dev
+```
+
+### Backend
+
+```
+$ cd backend
+$ yarn install
+$ cp .env.example .env
+```
+
+`BOT_WELCOME_MESSAGE` This is the Bot welcome message
+
+`BOT_TOKEN` This is the access token that you get from @BotFather when you create your Telegram bot.
+
+`WEB_APP_URL` This is the url of the frontend
+
+- Replace BOT_WELCOME_MESSAGE with your sweet message
+- Replace BOT_TOKEN by obtain your Bot Token from BotFather
+- Replace the WEB_APP_URL with the frontend endpoint
+  > You may need "ngrok" to expose the frontend endpoint in order to make it valid in Telegram Mini App
+
+**3. Start the app**
+
+```
+$ yarn dev
+```