
Webscraper application built from the ground up using Node.js, Express, Jest, Eslint, among other technologies.
Warning
This project is a Hackathon submission for Olostep for HeadStarter AI, a fellowship program dedicated to provide opportunities for the next generation. Part of Track A, which is focused on building towards 1000 users after a product launch, this project is a webscraper application built from the ground up using Node.js, Express, Jest, Eslint, among other technologies.
This is a general step-by-step guide on how to get the application up and running on your own machine, for development or for any testing purposes you may refer to the documentation for more information.
To be able to run the application, you should have the following installed on your machine:
Firstly, clone the repository:
git clone https://github.com/NautilusAI/Customer-Support-AI.git .
NOTE: The
.
at the end of the command clones the repository into the current directory, rather than creating a new directory with the name of this repo.
Next, install the dependencies found within the package.json
file:
npm install | npm i
You should now be able to run the application locally, I suggest using the run.cmd
command to start the application:
.\run.cmd
But you can also just the application using the following commands:
npm run dev
if you don't intend to use npm
, you can also use yarn
, pnpm
, or bun
to run the application (or any other package manager you prefer):
yarn dev
# or
pnpm dev
# or
bun dev
NOTE: If the command doesn't exist, or there are some issues, please check the
package.json
file for the correct command.
To use the application, you can navigate to the following URL:
http://localhost:3000
NOTE: All applications build using Next.js will usually run on port
3000
, but this can be changed within thenext.config.js
file.
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.