Add truffle project

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10

.github/workflows/solidity.yml

@@ -0,0 +1,33 @@
+name: Solidity CI
+
+on:
+  push:
+    branches: [ master ]
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '14'
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Compile
+      run: npx truffle compile
+
+    - name: Test
+      run: npx truffle test

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+build

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) [2024] [Lotso Project]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,8 +1,73 @@
-# Lotso Contract
+# Lotso Token and Lotso Airdrop
 
 ## Introduction
 
-This repository contains the contract ABI as well as the source code written in Solidity for the Lotso Token and the Lotso Airdrop.
+This repository contains the contract ABI as well as the source code written in Solidity for the Lotso Token and the Lotso Airdrop. These contracts are designed to introduce an innovative approach to digital tokens and airdropping techniques, leveraging Ethereum's powerful smart contract capabilities.
+
+## Installation
+
+To set up this project locally, follow these steps:
+
+1. **Clone the Repository**:
+   ```bash
+   git clone [email protected]:BTI-US/Lotso-Contract.git
+   ```
+
+2. **Navigate to the Project Directory**:
+   ```bash
+   cd lotso-token-and-airdrop
+   ```
+
+3. **Install Dependencies**:
+   ```bash
+   npm install
+   ```
+
+4. **Compile the Contracts**:
+   ```bash
+   truffle compile
+   ```
+
+## Usage
+
+### Running Tests
+
+Run tests to ensure the contracts are functioning as expected:
+
+```bash
+truffle test
+```
+
+### Deployment
+
+Deploy the contracts to a local development network:
+
+1. Start the Truffle development console:
+   ```bash
+   truffle develop
+   ```
+
+2. Deploy the contracts inside the development console:
+   ```bash
+   migrate
+   ```
+
+## Project Structure
+
+- `contracts/`: Contains the Solidity code for Lotso Token and Lotso Airdrop.
+- `migrations/`: Migration scripts for deploying the contracts.
+- `test/`: JavaScript test files for the smart contracts.
+- `truffle-config.js`: Configuration file for the Truffle framework.
+
+## Contributing
+
+Contributions are what make the open-source community an amazing place to learn, inspire, and create. Any contributions you make to the Lotso Token and Lotso Airdrop project are **greatly appreciated**.
+
+Please read the contributing guidelines for details on our code of conduct, and the process for submitting pull requests to us.
+
+## License
+
+This project is licensed under the [LICENSE TYPE] - see the [LICENSE](LICENSE) file for details.
 
 ## Contract ABI for Lotso Token