Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,47 @@

![Website Preview](assets/homepage_preview.png)


## আমাদের সম্পর্কে কিছু কথা
> একবুক স্বপ্ন নিয়ে অসাধারন কিছু মানুষের জন্য নিরালস পরিশ্রম করে যাওয়া একটা টিমের নাম **Code Eating Ants**‌\
> আমরা ওয়েব অটোমেশন, জাভাস্ক্রিপ্ট, পাইথন, ওয়ার্ডপ্রেস, ইউআই/ইউএক্স ডিজাইন এবং গ্রাফিক্স ডিজাইন নিয়ে কাজ করছি। আমরা ফ্রিল্যান্সিং শেখায় না। একমাত্র আমরাই লাইভ প্রজেক্টগুলো কিভাবে পরিপূর্ন করে ডেলিভারি করতে হয় সেটা শেখায়। আমাদের সম্পর্কে বিস্তারিত জানতে [ভিজিট](https://codeeatingants/com) করুন।


## ডেভেলপমেন্ট
ওয়েবসাইট টি আপনার লোকাল কম্পিউটারে রান করার জন্য প্রথমে আপনাকে
[NodeJS](https://nodejs.org/en/) ও [Yarn](https://yarnpkg.com/) ইন্সটল করে নিতে হবে।
NodeJs এবং Yarn ইনস্টল করা আছে কিনা তা যাচাই করতে টার্মিনাল ওপেন করে নিচের কমান্ডগুলো দিয়ে যান।

প্রথমে NodeJS ও Yarn ইন্সটল করে নিন, এবং প্রজেক্টটি ক্লোন করুন। এরপর নিচের ধাপগুলো অনুসরণ করুন।
```bash
node --version
yarn --version
```
NodeJs এবং Yarn ইনস্টল করা হয়ে গেলে প্রজেক্টটি ক্লোন করে প্রজেক্টের রুট ডিরেক্টরীতে টার্মিনাল ওপেন করুন এবং তারপর নিচের ধাপগুলো অনুসরণ করুন।

১ - ডিপেন্ডেন্সিগুলো ইন্সটল করুন

```
```bash
yarn
```

২ - ডেভেলপমেন্ট মোডে চালু করুন

```
```bash
yarn start
```

ব্রাউজারে http://127.0.0.1:1234/ লিংকটি ওপেন করুন। সবকিছু ঠিকঠাক থাকলে আপনি ওয়েবসাইটটি দেখতে পারবেন।

৩ - বিল্ড করতে

```
```bash
yarn run build
```
প্রজেক্টটি বিল্ড হওয়ার পরে প্রয়োজনীয় সবকিছু dist ফোল্ডারে জমা হবে।

সবকিছু dist ফোল্ডারে জমা হবে।
## কন্ট্রিবিউট করুন
যেকোন সংযোজন,সংশোধন বা পরিমার্জনের জন্য [পুল রিকুয়েস্ট](https://github.com/code-eating-ants/homepage/pulls) পাঠাতে পারেন। পুল রিকুয়েস্ট পাঠানোর পুর্বে আপনি একটা [নতুন ইস্যু](https://github.com/code-eating-ants/homepage/issues) তৈরী করে আমাদের জানালে আমরা সর্বোচ্চ খুশি হব।
ধন্যবাদ।

**#হ্যাপি_কোডিং :)**
## লাইসেন্স
[MIT](https://choosealicense.com/licenses/mit/)