Skip to content

Bikcraft is a team of creative people who design, build and sell custom bikes.

License

Notifications You must be signed in to change notification settings

lucasmc64/bikcraft

Repository files navigation

Bikcraft

🚲 Bikcraft

This was a project developed during the Origamid Web Design course.

🐺 What is Origamid?

Origamid is an online education institution created by André Rafael with the aim of transmitting his knowledge in Front-end and UI&UX.

🎯 Goal

Bikcraft is a team of creative people who idealize, build and sell customized bikes, positively impacting the environment and the physical well-being of customers.

📜 Some details

  • Sending forms, unlike the original project, is done through Node.JS.
  • The front-end is made with HTML5, CSS3 and JavaScript.

🤔 How do I run the project on my machine?

The first step is to clone the project, either via terminal or GitHub Desktop, or even by downloading the compressed file (.zip). After that, go ahead.

🛠️ Requirements

If you just want to take a look at the interface, none of the requirements below are required, just open the index.html file in your preferred browser.

However, if you want to test the form submission functionality, the tools below are required.

🔍 Installing dependencies

With Node.JS installed, access the server folder via terminal and run the npm install command. If you prefer to use Yarn, just run the command yarn.

🥽 Running the back-end

Before running the server, it is necessary to make a configuration. Open the server/src/mailer.js file and add your SMTP login credentials, also changing the * host * and * port * as provided by your preferred service.

For my tests I used the services of Mailtrap.

Login credentials

Access the server directory via terminal and run npm start or yarn start and a message similar to the following will appear for you:

Running the server

Note: If this was not the result, check that the requirements and previous steps have been met.

✨ Running the front-end

Open the project folder in VSCode and, by right-clicking on the index.html file, choose Open with Live Server. A server will be started by the extension and it will open the website in your default browser.

Don't forget to leave the back-end running in parallel!

🎉 If everything went well...

Now you are running the project beautifully!

📝 License

This project is under the MIT license. See the LICENSE for more information.


Made with 🖤 by Lucas Coutinho 👋 Get in touch!