|| Auklo| C# Team Week 2020 ||

___________________________

Natalie Murphy Grant Eadie Michael Watts

Created on November 1st, 2020.

---

Table of Contents

• About the Project
  • Description
  • Known Bugs
  • Built With
  • Preview
  • Getting Started
  • Setup and Use
  • Auxiliary
  • Contributors
  • Contact
  • License
  • Acknowledgements

---

🌐 About the Project

📖 Description

Procedurally generated ambient music maker that has an infinite timeline of sound built using C#/Javascript/MySql. Using different filters and effects, You are able to create and save your own ambient music.

"Its actually pretty easy to get some sounds coming out of a web application." - Someone on Youtube

🔍 Examples & Resources

• Web Audio API from Mozilla."
• Intro Turtorial we build a simple boombox
• Basic Concepts behind Web Audio API
• Form using WebAudio API
• Oscillator Node > a very cool example
• Media Element Audio Source Node > example: this is cool, its moving your mouse around the screen to change things about the media playing
• Gain Node > example: voice-change
• Example Repo for WebAudio

🦠 Known Bugs

• None known at the moment.

🛠 Built With

• Visual Studio Code
• C#
• ASP.NET Core MVC
• MySQL
• Entity Framework Core 2.2.6
• Tone.js

🔍 Preview

---

🏁 Getting Started

Install .NET Core

• On macOS Mojave or later
  • Click here to download the .NET Core SDK from Microsoft Corp for macOS.
• On Windows 10 x64 or later
  • Click here to download the 64-bit .NET Core SDK from Microsoft Corp for Windows.

Install dotnet script

Enter the command dotnet tool install -g dotnet-script in Terminal for macOS or PowerShell for Windows.

Install MySQL Workbench

Download and install the appropriate version of MySQL Workbench.

Code Editor

To view or edit the code, you will need an code editor or text editor. The popular open-source choices for an code editor are Atom and VisualStudio Code.

1. Code Editor Download:
   • Option 1: Atom
   • Option 2: VisualStudio Code
2. Click the download most applicable to your OS and system.
3. Wait for download to complete, then install -- Windows will run the setup exe and macOS will drag and drop into applications.
4. Optionally, create a GitHub Account

⚙️ Setup and Use

Cloning

1. Navigate to the Auklo.
2. Click 'Clone or download' to reveal the HTTPS url ending with .git and the 'Download ZIP' option.
3. Open up your system Terminal or GitBash, navigate to your desktop with the command: cd Desktop, or whichever location suits you best.
4. Clone the repository to your desktop: $ git clone https://github.com/murphynd/AudioProject.git
5. Run the command cd AudioProject to enter into the project directory.
6. View or Edit:
   • Code Editor - Run the command atom . or code . to open the project in Atom or VisualStudio Code respectively for review and editing.
   • Text Editor - Open by double clicking on any of the files to open in a text editor.

Download

1. Navigate to the Auklo.
2. Click 'Clone or download' to reveal the HTTPS url ending with .git and the 'Download ZIP' option.
3. Click 'Download ZIP' and unextract.
4. Open by double clicking on any of the files to open in a text editor.

Database Settings

1. Create a new file in the AudioProject directory named appsettings.json
2. Add in the following code snippet to the new appsettings.json file:

{
  "Logging": {
      "LogLevel": {
      "Default": "Warning"
      }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
      "DefaultConnection": "Server=localhost;Port=3306;database=audio_project0;uid=root;pwd=YourPassword;"
  }
}

3. Change the server, port, and user id as necessary. Replace 'YourPassword' with relevant MySQL password (set at installation of MySQL).

Database

1. Navigate to AudioProject directory using the MacOS Terminal or Windows Powershell (e.g. cd Desktop/ParkWatch.Solutions/AudioProject).
2. Run the command dotnet ef database update to generate the database through Entity Framework Core.
3. (Optional) To update the database with any changes to the code, run the command dotnet ef migrations add <MigrationsName> which will use Entity Framework Core's code-first principle to generate a database update. After, run the previous command dotnet ef database update to update the database.

🤝 Contributors

Author	GitHub	Email
Michael Watts	Michael Watts	wattsjmichael@gmail.com
Grant Eadie	Grant Eadie	grantleadie@gmail.com
Natlie Murphy	Natalie Murphy	nataliemurphy500@gmail.com

---

✉️ Contact and Support

If you have any feedback or concerns, please contact one of the contributors.

---

⚖️ License

This project is licensed under the MIT License. Copyright (C) 2020 Natalie Murphy, Grant Eadie, Michael Watts All Rights Reserved.

MIT License

Copyright (c) 2020 Natalie Murphy, Grant Eadie, Michael Watts

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.

---

🌟 Acknowledgments

Epicodus

"A school for tech careers... to help people learn the skills they need to get great jobs."

---

🍎 Guidance Used

Guidance on a great API README - LondresRi

‿︵‿︵‿ヽ(°□° )ノ︵‿︵‿︵

Return to Top ```