Created Readme and added context

szubair22 · Sep 30, 2024 · 2850ced · 2850ced
1 parent 4e21ed7
commit 2850ced
Show file tree

Hide file tree

Showing 2 changed files with 87 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,62 @@
+# CSV Mapping Tool for Sage Intacct
+
+This web application helps Sage Intacct users easily map their data to Sage Intacct's required format. The tool allows users to upload their data CSV and an Intacct template CSV, preview the contents, and generate a mapped CSV file that conforms to Intacct's specifications.
+
+## Features
+
+- Upload and preview data CSV files
+- Upload and preview Intacct template CSV files
+- Automatic field mapping between data CSV and Intacct template
+- Generate and download mapped CSV files ready for Intacct import
+
+## How to Use
+
+1. Visit the [CSV Mapping Tool](https://szubair22.github.io/CSVtoIntacctMapper/) website.
+2. Upload your data CSV file.
+3. Upload the Intacct template CSV file.
+4. Click "Upload and Preview" to see the contents of both files.
+5. Review the field mapping generated by the tool.
+6. Click "Generate and Download Mapped CSV" to create and download the final mapped CSV file.
+
+## Technology Stack
+
+- Frontend: HTML, CSS, JavaScript
+- Backend: Python (Flask)
+
+## Local Development
+
+To run this project locally:
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/szubair22/CSVtoIntacctMapper.git
+   ```
+
+2. Navigate to the project directory:
+   ```bash
+   cd CSVtoIntacctMapper
+   ```
+
+3. Install the required Python packages:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4. Run the Flask application:
+   ```bash
+   python app.py
+   ```
+
+5. Open your web browser and visit `http://localhost:5000`.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is open source and available under the [MIT License](LICENSE).
+
+## Contact
+
+If you have any questions or feedback, please open an issue on this GitHub repository.
diff --git a/index.html b/index.html
@@ -10,19 +10,41 @@
 <body class="bg-white text-black">
     <div class="container mx-auto px-4 py-8 max-w-4xl">
         <div class="text-center mb-8">
-            <h1 class="text-3xl font-bold">CSV Mapping Tool for Sage Intacct</h1>
+            <h1 class="text-3xl font-bold mb-2">CSV Mapping Tool for Sage Intacct</h1>
+            <p class="text-xl text-gray-600">Save time and reduce errors by automating the mapping process.</p>
         </div>
 
+        <div class="mb-8">
+            <h2 class="text-2xl font-semibold mb-4">How It Works</h2>
+            <ol class="list-decimal list-inside space-y-4">
+                <li>
+                    <strong>Upload Your Files:</strong>
+                    <ul class="list-disc list-inside ml-6 mt-2">
+                        <li>First, upload your data CSV.</li>
+                        <li>Then, upload your Intacct Template CSV.</li>
+                    </ul>
+                </li>
+                <li>
+                    <strong>Preview and Map:</strong>
+                    <ul class="list-disc list-inside ml-6 mt-2">
+                        <li>Match the data fields from your file to the Intacct format.</li>
+                        <li>Review the mappings before finalizing.</li>
+                    </ul>
+                </li>
+            </ol>
+            <p class="mt-4">Once your files are uploaded and mapped, you're ready to seamlessly import them into Sage Intacct!</p>
+        </div>
+
         <div class="mb-8">
             <h2 class="text-xl font-semibold mb-4">Upload CSV Files</h2>
             <form id="uploadForm" class="space-y-4">
                 <div>
                     <label for="dataFile" class="block mb-2">Data CSV:</label>
-                    <input type="file" id="dataFile" name="dataFile" accept=".csv" required class="block w-full text-sm text-gray-700 file:mr-4 file:py-2 file:px-4 file:rounded-full file:border-0 file:text-sm file:font-semibold file:bg-black file:text-white hover:file:bg-gray-800">
+                    <input type="file" id="dataFile" name="dataFile" accept=".csv" required class="block w-full text-sm text-black file:mr-4 file:py-2 file:px-4 file:rounded-full file:border-0 file:text-sm file:font-semibold file:bg-black file:text-white hover:file:bg-gray-800 bg-gray-100">
                 </div>
                 <div>
                     <label for="templateFile" class="block mb-2">Intacct Template CSV:</label>
-                    <input type="file" id="templateFile" name="templateFile" accept=".csv" required class="block w-full text-sm text-gray-700 file:mr-4 file:py-2 file:px-4 file:rounded-full file:border-0 file:text-sm file:font-semibold file:bg-black file:text-white hover:file:bg-gray-800">
+                    <input type="file" id="templateFile" name="templateFile" accept=".csv" required class="block w-full text-sm text-black file:mr-4 file:py-2 file:px-4 file:rounded-full file:border-0 file:text-sm file:font-semibold file:bg-black file:text-white hover:file:bg-gray-800 bg-gray-100">
                 </div>
                 <button type="submit" class="bg-black hover:bg-gray-800 text-white font-bold py-2 px-4 rounded">
                     Upload and Preview